Merge pull request #841 from microsoftgraph/feat/tsp-fixes

feat/tsp fixes

Author: baywet

.github/dependabot.yml

@@ -5,3 +5,9 @@ updates:
   schedule:
     interval: daily
   open-pull-requests-limit: 10
+
+- package-ecosystem: npm
+  directory: "/additions"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.github/workflows/validate-typespec-changes.yml

@@ -0,0 +1,36 @@
+name: validate typespec changes
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: additions
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.x'
+
+      - name: Install typescript and typespec globally
+        run: npm i -g typescript @typespec/compiler
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: build typespec
+        run: tsp compile .
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: CSDLs
+          path: tsp-output/*.csdl

additions/.gitignore

@@ -0,0 +1,9 @@
+# MacOS
+.DS_Store
+
+# Default TypeSpec output
+tsp-output/
+dist/
+
+# Dependency directories
+node_modules/

additions/README.md

@@ -0,0 +1,21 @@
+# TypeSpec annotations additions
+
+This TypeSpec project allows you to define additional annotations to inject in the CSDL files. It's an alternative to the XLST in `/transform`.
+The copy scripts (in `/scripts/copy-annotations-to-csdl.ps1`) ONLY considers annotations, and DOES NOT perform any deduplication other than the ones enforced by XML keys.
+
+## Requirements
+
+- Node 22.x or above
+- TypeScript `npm i -g typescript`
+- TypeSpec compiler `npm i -g @typespec/compiler`
+- dependencies installed `npm ci`
+- vscode (or equivalent) `sudo winget install Microsoft.VisualStudioCode`
+
+## Getting started
+
+1. Make changes to the TypeSpec (.tsp) file
+1. Run the compilation `tsp compile . --watch`
+1. Run the copy scripts `.\scripts\copy-annotations-to-csdl.ps1 -sourceCsdlDirectoryPath $pwd\additions\tsp-output -targetCsdlPath $pwd\clean_v10_metadata\cleanMetadataWithDescriptionsAndAnnotationsAndErrorsv1.0.xml`
+1. Diff the changes to ensure this is what you expect
+
+> Note: Do not commit any changes to the target CSDL as those are generated weekly.

additions/main.tsp

@@ -0,0 +1,21 @@
+import "@microsoft/typespec-msgraph";
+
+using MsGraph;
+
+@publicNamespace("microsoft.graph")
+@container("GraphService")
+namespace microsoft.graph {
+
+	@entity()
+	model OrgContact extends SharedModels.entity {
+		displayName: string | null
+	}
+	@graphRoute("contacts/{id}")
+	interface OrgContactsById extends Resource<OrgContact> {
+        @select GetResource is GraphOps.GetResource;
+	}
+	@graphRoute("contacts")
+	interface OrgContacts extends Collection<OrgContact> {
+        @orderBy("displayName") @filter("*") @search @count @select @top GetCollection is GraphOps.GetPagedCollection;
+	}
+}