Skip to content

Conversation

@vaibhavbhalla2505
Copy link
Contributor

@vaibhavbhalla2505 vaibhavbhalla2505 commented Aug 4, 2025

BREAKING CHANGE:
yes

Description

Updated the angular version and its dependencies
Support for angular version 18

Fixes # (issue)

GH-39

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Intermediate change (work in progress)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Performed a self-review of my own code
  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Any dependent changes have been merged and published in downstream modules

@vaibhavbhalla2505 vaibhavbhalla2505 self-assigned this Aug 4, 2025
@vaibhavbhalla2505 vaibhavbhalla2505 added the breaking breaking change label Aug 4, 2025
@vaibhavbhalla2505 vaibhavbhalla2505 linked an issue Aug 4, 2025 that may be closed by this pull request

This comment was marked as outdated.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Angular framework and its dependencies from version 17 to version 18 across the search client library. This is a breaking change that adds support for Angular v18 while maintaining backward compatibility documentation.

  • Updated all Angular-related dependencies from ^17.3.0 to ^18.0.0
  • Updated TypeScript to version ~5.4.3 to align with Angular 18 requirements
  • Added version compatibility documentation to clarify usage patterns

Reviewed Changes

Copilot reviewed 6 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
sandbox/search-client-example/package.json Updated Angular dependencies and TypeScript version for the example application
packages/search/projects/search-lib/package.json Updated peer dependencies to Angular 18 for the search library
packages/search/projects/search-lib/README.md Added version compatibility notice documenting Angular 17 vs 18 usage
packages/search/projects/search-element/package.json Updated hash value for the search element package
packages/search/package.json Updated Angular dependencies and build tools to version 18
packages/search/README.md Added version compatibility notice and updated deprecation message
Files not reviewed (1)
  • packages/search/projects/search-lib/package-lock.json: Language not supported


- For Angular v17, use @sourceloop/search-client version ^7.x.x.

- For Angular v18, use @sourceloop/search-client version ^8.x.x
Copy link

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation mentions version ^8.x.x for Angular v18, but the package version in the library is still 7.0.1. This creates confusion about which version users should actually use.

Suggested change
- For Angular v18, use @sourceloop/search-client version ^8.x.x
- For Angular v18, use @sourceloop/search-client version ^7.x.x

Copilot uses AI. Check for mistakes.
Search-client now supports Angular v17, we will provide support for the older version that is based on Angular v14 till 30th August 2025 .
- For Angular v17, use @sourceloop/search-client version ^7.x.x.

- For Angular v18, use @sourceloop/search-client version ^8.x.x
Copy link

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation states users should use version ^8.x.x for Angular v18, but this version doesn't appear to exist yet. The package version remains at 7.0.1, which could mislead users.

Suggested change
- For Angular v18, use @sourceloop/search-client version ^8.x.x
- For Angular v18, use @sourceloop/search-client version ^7.x.x until version ^8.x.x is released.
**Note:** Version ^8.x.x is not yet available. Please check the [npm registry](https://www.npmjs.com/package/@sourceloop/search-client) for updates.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@sourceloop/search-client: Add support for angular v18

4 participants