Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 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
3 changes: 3 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ jobs:
with:
node-version: 22
registry-url: https://registry.npmjs.org/
- name: Copy README.md to packages
shell: pwsh
run: ./script/copy-readme.ps1
- run: npm ci
- run: npm run build
- run: npx lerna publish from-package --no-push --yes
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
node_modules/
lib/
*.log
*.tgz
*.tgz

*.idea/
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Microsoft Graph SDK for Typescript

Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your Typescript application!

> [!NOTE]
> The Microsoft Graph Typescript SDK is currently in Pre-Release. This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs.
>
> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.

## 1. Installation

Expand All @@ -23,14 +23,14 @@ npm install @microsoft/msgraph-sdk-users

### 2.1 Register your application

Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://learn.microsoft.com/graph/auth-register-app-v2).

### 2.2 Create an AuthenticationProvider object

An instance of the **GraphServiceClient** class handles building client. To create a new instance of this class, you need to provide an instance of **AuthenticationProvider**, which can authenticate requests to Microsoft Graph.

<!-- TODO restore that and remove the snippets below once the SDK hits GA and the public documentation has been updated -->
Comment thread
baywet marked this conversation as resolved.
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://docs.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->

#### 2.2.1 Authorization Code Provider

Expand Down Expand Up @@ -149,7 +149,7 @@ const graphServiceClient = createGraphServiceClient(requestAdapter);

## 3. Make requests against the service

After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://docs.microsoft.com/graph/api/overview?view=graph-rest-1.0).
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0).

### 3.1 Get user's detailed information

Expand All @@ -169,9 +169,9 @@ const jane = await graphServiceClient.users.byUserId("jane@contoso.com").get();

For more detailed documentation, see:

* [Overview](https://docs.microsoft.com/graph/overview)
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
* [Overview](https://learn.microsoft.com/graph/overview)
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)

Expand Down
11 changes: 0 additions & 11 deletions packages/msgraph-sdk-admin/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-agreementAcceptances/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-agreements/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-appCatalogs/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-applicationTemplates/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-applications/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-auditLogs/README.md

This file was deleted.

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-authenticationMethodsPolicy/README.md

This file was deleted.

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-chats/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-communications/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-compliance/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-connections/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-contacts/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-contracts/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-dataPolicyOperations/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-deviceAppManagement/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-deviceManagement/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-devices/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-directory/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-directoryObjects/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-directoryRoleTemplates/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-directoryRoles/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-domainDnsRecords/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-domains/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions packages/msgraph-sdk-drives/README.md

This file was deleted.

Loading