Skip to content

Latest commit

 

History

History
214 lines (146 loc) · 9.63 KB

ChangeLog.md

File metadata and controls

214 lines (146 loc) · 9.63 KB
Raw

PSBluesky Changelog

This changelog is based on Keep a Changelog.

Unreleased

2.1.0 - 2024-11-21

Added

  • Added alias bss for Get-BskySession.
  • Added function Get-BskyAccountDID.
  • Added parameter validation on image uploads to verify the image file size is less than 1MB.
  • Merged PR #23 from @jhoneill to add label support for New-BskyPost and -Username to Get-BskyFeed.
  • Added command Get-BskyAccountDID. This command does not require authentication.

Changed

  • Made PostCache a global-scoped variable and renamed it to `BskyPostCache``. Thanks to @ShaunLawrie for the suggestion
  • Revised parameter validations on ImagePath to provide more granular error messages.
  • Updated README with documentation about setting up a credential using an app password.
  • Revised OnRemove handler to remove type customizations. This should eliminate errors on module re-import in the same session.

Removed

  • Removed gif as a valid image type to upload.

Fixed

  • Modified New-BskyPost to re-order items that require facets so that the message is properly formatted. [Issue #22]

2.0.0 - 2024-11-18

Added

  • Added script property called Age for types PSBlueskyProfile, PSBlueskyFollowProfile, and PSBlueskySearchResult.
  • Added custom verbose messaging and localized string data.
  • Added typename PSBlueskyImageUpload to Add-BskyImage.
  • Added command Get-BskyModuleInfo and corresponding formatting file.
  • Added a parameter to Open-BskyHelp to view the file as a markdown document.
  • Added support for proper notifications and tags in new messages. [Issue #19]
  • Added command aliases:
    • bsfeed --> Get-BskyFeed
    • bsfollow --> Get-BskyFollowing
    • bsfollower --> Get-BskyFollowers
    • bshelp --> Open-BskyHelp
    • bsn --> Get-BskyNotification
    • bsp --> Get-BskyProfile
    • bst --> Get-BskyTimeline
    • bsu --> Find-BskyUser
    • Refresh-BskySession --> Update-BskySession
    • skeet --> New-BskyPost

Changed

  • Modified commands to not require a credential except for Start-BskySession. Commands will get the access token from the session object. This is a breaking change [Issue #20]

Removed

  • Removed Get-BskyAccessToken and replaced it with Start-BskySession. This is a breaking change

1.3.0 - 2024-11-15

Added

  • Added command Find-BSkyUser and corresponding format file.
  • Added code to get the text of referenced posts and cache them in a hashtable. The caching hashtable is referenced by a module-scoped variable.

Changed

  • Modified commands to use a user's DID instead of the username or handle. Some API endpoints don't work well with handles. This is a possible breaking change [Issue #18]
  • Minor code cleanup and refactoring. Increased the use of splatting to improve code readability.
  • Updated the profile object to include the account DID.
  • Modified formatting and the default object for Bluesky notifications to include the text of a reference post that is either liked or reposted. This is a breaking change.
  • Updated Get-BskyNotification to allow filtering by notification type.
  • Updated formatting file for notifications to support additional notification types.
  • Updated help documentation.
  • Updated README.md

Fixed

  • Added support for repost and reply notifications in the PSBlueskyNotification.format.ps1xml file. [Issue #17]
  • Fixed notification hyperlinks in PSBlueskyNotification.format.ps1xml.

1.2.0 - 2024-11-13

Added

  • Added the alias Alt for ImageAlt in New-BskyPost.
  • Added alias Refresh-BskySession for Update-BskySession
  • Accepted PR #12 to fix casing issues which were causing problems loading the module on Linux. Thanks @Skatterbrainz!
  • Added additional verbose messaging to commands to show what platform is being used and the module version.
  • Added command Get-BskyNotification and corresponding format file.

Changed

  • Updated Get-BskyFollowers to use paging to get all followers. PR #11 Thanks to @Skatterbrainz for solving an issue on my to do list.
  • Updated New-BskyPost to properly handle mentions and format as inline links. [Issue #14]
  • Update Get-BskyFollowing to allow the user to get all accounts. [Issue #16]
  • Major update to the way the module handles the session object and tokens. The module uses a background runspace to update the session object every 15 minutes. This should keep your Bluesky access tokens good for as long as the module is loaded without having to worrying about refreshing the module. This is a breaking change.
  • Updated README.md to reflect changes and new features.

1.1.0 - 2024-11-07

Added

  • Moved the helper function _RefreshSession to a public function, Update-BskySession.

Changed

  • Modified New-BSkyPost to accept pipeline input.
  • Updated default formatting for Bluesky timeline items to use a custom format. The Table definition remains as a named view.
  • Modified session code to refresh the session if the age is greater than 60 minutes.
  • Updated README.md.
  • Revised the PDF help document formatting.
  • Help documentation updates.

1.0.0 - 2024-11-02

Changed

  • Renamed help PDF file to PSBlueSky-Help.pdf. This is probably a break change but since the expectation is to run Open-BskyHelp (which has been updated with the new file name) to open the file, it shouldn't be an issue.
  • Updated New-BskyPost to support Markdown style links. [Issue #6]
  • Updated README.md.
  • Updated module manifest to version 1.0.0. This should be a very stable version with almost all of the intended functionality.

0.6.0 - 2024-11-01

This is the first version published to the PowerShell Gallery.

Added

  • Added command Open-BskyHelp to open a PDF version of the module's README.md file.
  • Added custom format file for PSBlueskySession objects.
  • Added alias properties AccessToken and RefreshToken for the PSBlueskySession object.

Changed

  • Updated help documentation

0.5.0 - 2024-10-31

Added

  • Added command Get-BskySession.
  • Added a ScriptProperty called Age for the profile type objects.
  • Added an Alias property of Name for UserName in the profile type objects.
  • Added a property set called Stats for timeline and feed objects.

Changed

  • Updated the module to re-use and refresh Bluesky sessions. This should help with API rate limits since the commands aren't creating a new session for each request. [Issue #7] This is a breaking change.
  • Modified Get-BskyProfile to default the username to the specified credential. [Issue #8]
  • Renamed module commands. Example Get-PSBlueskyProfile is now Get-BskyProfile. This is a breaking change
  • Documentation updates and corrections.
  • Modified commands that write Profile type objects to use the accounts username for the DisplayName, if the DisplayName is not defined.
  • Updated Pester tests.

0.4.0 - 2024-10-27

Added

  • Added command help documentation. [Issue #4]
  • Added command Get-BskyFollowers and associated format file
  • Added command Get-BskyFollowing which uses the same format file as Get-BskyFollowers.
  • Added command Get-BskyFeed and associated custom format file.

Changed

  • Updated README.md.
  • Modified Get-BskyProfile to accept user name as pipeline input.

Fixed

  • Hopefully fixed linking in new posts. Issue #3

0.3.0 - 2024-10-26

Added

  • Added custom format file for profiles.
  • Added command Get-BskyTimeline and corresponding format file.

Changed

  • Updated the Bluesky profile object to include a URL to the profile.
  • Updated the ability to post links.
  • Updated README.md.

0.2.0 - 2024-10-25

Changed

  • Changed casing references from BlueSky to bluesky.
  • Updated README.md.
  • Changed the global PDSHOSTvariable to a module-scoped variable.

0.1.0 - 2024-10-25

Added

  • initial files and module structure