[WIP] Planetary Computer Modular Client #36401
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…pconfig.yaml', API Version: 2025-04-30-preview, SDK Release Type: beta, and CommitSHA: '6caf6d9259e8ee9d5149d88c1857abfa08776543' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=5521485 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
…dk-gen-pup-js-mod
chahibi
requested review from
a team,
MaryGao,
bterlson,
jeremymeng,
qiaozha and
xirzec
as code owners
github-actions
bot
added
the
Mgmt
chahibi
changed the title
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new @azure-rest/planetarycomputer package for the Azure SDK for JavaScript, providing TypeScript client support for the Microsoft Planetary Computer Pro geo-catalog service. This is a generated client based on the Azure REST API specifications.
Key changes:
- Adds complete TypeScript client implementation for Planetary Computer Pro API
- Includes configuration files for testing (Vitest), TypeScript compilation, and build setup
- Provides comprehensive model definitions for STAC (SpatioTemporal Asset Catalog) operations
- Implements helper utilities for paging, polling (LRO), URL templating, and multipart uploads
Reviewed Changes
Copilot reviewed 59 out of 61 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| vitest.esm.config.ts | ESM-specific Vitest configuration merging shared configs |
| vitest.config.ts | Base Vitest configuration importing shared settings |
| vitest.browser.config.ts | Browser-specific Vitest configuration |
| tsp-location.yaml | TypeSpec location metadata pointing to API spec source |
| tsconfig.*.json | TypeScript configuration files for various build targets |
| test/snippets.spec.ts | Sample test snippets demonstrating client usage |
| test/public/utils/recordedClient.ts | Test recorder utility setup |
| test/public/sampleTest.spec.ts | Sample test case with recorder setup |
| src/static-helpers/*.ts | Helper utilities for URL templating, paging, polling, serialization |
| src/models/models.ts | Comprehensive model definitions (4716 lines) |
| src/logger.ts | Logger setup using @azure/logger |
| src/index.ts | Main package entry point with all exports |
| src/planetaryComputerProClient.ts | Main client class implementation |
| src/restorePollerHelpers.ts | LRO poller restoration utilities |
| src/classic/**/*.ts | Classic-style operation groups |
| src/api/**/*.ts | API layer with operations and context |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
chahibi
added
the
Consumption - UsageDetailsAndExport
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Packages impacted by this PR
@azure/planetarycomputerIssues associated with this PR
N/A
Describe the problem that is addressed by this PR
This PR introduces a new TypeScript client SDK for the Microsoft Planetary Computer Pro geo-catalog service. The Planetary Computer Pro service provides access to geospatial data through a STAC (SpatioTemporal Asset Catalog) API, enabling users to discover, access, and analyze Earth observation data.
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
N/A
Are there test cases added in this PR? (If not, why?)
In progress
Provide a list of related PRs (if any)
N/A
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Generated from TypeSpec configuration at
specification/orbital/Microsoft.PlanetaryComputer/tspconfig.yaml6caf6d9259e8ee9d5149d88c1857abfa08776543Checklists