Merge pull request #2298 from ably/pubsub-split/rename-references

Update repository references for rename to ably-pubsub-js

Author: umair-ably

.github/workflows/bundle-report.yml

@@ -32,7 +32,7 @@ jobs:
       - uses: aws-actions/configure-aws-credentials@67fbcbb121271f7775d2e7715933280b06314838 # v1
         with:
           aws-region: eu-west-2
-          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-js
+          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-pubsub-js
           role-session-name: '${{ github.run_id }}-${{ github.run_number }}'
       - uses: ably/sdk-upload-action@8c6179796fc7ee8fc9bb28d5223ffef005b985cc # v1
         with:

.github/workflows/docs.yml

@@ -60,7 +60,7 @@ jobs:
         uses: aws-actions/configure-aws-credentials@67fbcbb121271f7775d2e7715933280b06314838 # v1
         with:
           aws-region: eu-west-2
-          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-js
+          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-pubsub-js
           role-session-name: '${{ github.run_id }}-${{ github.run_number }}'
 
       - name: Upload Documentation

.github/workflows/features.yml

@@ -14,6 +14,6 @@ jobs:
       id-token: write
     uses: ably/features/.github/workflows/sdk-features.yml@6b3fc7a8ede2ebdd7a6325314f3a96c6466f1453 # main
     with:
-      repository-name: ably-js
+      repository-name: ably-pubsub-js
     secrets:
       ABLY_AWS_ACCOUNT_ID_SDK: ${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}

.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
-ably-js.iml
+ably-pubsub-js.iml
 .idea
 node_modules
 npm-debug.log

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to ably-js
+# Contributing to ably-pubsub-js
 
 ## Contributing
 
@@ -7,7 +7,7 @@
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Ensure you have added suitable tests and the test suite is passing(`npm test`)
-6. Ensure the [type definitions](https://github.com/ably/ably-js/blob/main/ably.d.ts) have been updated if the public API has changed
+6. Ensure the [type definitions](https://github.com/ably/ably-pubsub-js/blob/main/ably.d.ts) have been updated if the public API has changed
 7. Push the branch (`git push origin my-new-feature`)
 8. Create a new Pull Request
 
@@ -23,7 +23,7 @@
 8. Run `git tag <VERSION_NUMBER>` with the new version and push the tag to GitHub with `git push <REMOTE> <VERSION_NUMBER>` (usually `git push origin <VERSION_NUMBER>`)
 9. Run `npm publish .` (should require OTP) - publishes to NPM
 10. Run the GitHub action "Publish to CDN" with the new tag name
-11. Visit https://github.com/ably/ably-js/tags and create a GitHub release based on the new tag (for release notes, you generally can just copy the notes you added to the CHANGELOG)
+11. Visit https://github.com/ably/ably-pubsub-js/tags and create a GitHub release based on the new tag (for release notes, you generally can just copy the notes you added to the CHANGELOG)
 12. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes (again, you can just copy the notes you added to the CHANGELOG)
 
 ## Building the library

README.md

@@ -1,6 +1,6 @@
 ![Ably Chat Header](/images/JavaScriptSDK-github.png)
 [![npm version](https://img.shields.io/npm/v/ably.svg?style=flat)](https://img.shields.io/npm/v/ably.svg?style=flat)
-[![License](https://badgen.net/github/license/ably/ably-js)](https://github.com/ably/ably-js/blob/main/LICENSE)
+[![License](https://badgen.net/github/license/ably/ably-pubsub-js)](https://github.com/ably/ably-pubsub-js/blob/main/LICENSE)
 
 ---
 
@@ -35,13 +35,13 @@ Ably aims to support a wide range of platforms and all current browser versions,
 
 The following platforms are supported:
 
-| Platform    | Support                                                                                  |
-| ----------- | ---------------------------------------------------------------------------------------- |
-| JavaScript  | ES2017                                                                                   |
-| Node.js     | See `engines` in [package.json](https://github.com/ably/ably-js/blob/main/package.json). |
-| React       | >=16.8.x                                                                                 |
-| TypeScript  | Type definitions are included in the package.                                            |
-| Web Workers | Browser bundle and [modular](#modular-variant) support.                                  |
+| Platform    | Support                                                                                         |
+| ----------- | ----------------------------------------------------------------------------------------------- |
+| JavaScript  | ES2017                                                                                          |
+| Node.js     | See `engines` in [package.json](https://github.com/ably/ably-pubsub-js/blob/main/package.json). |
+| React       | >=16.8.x                                                                                        |
+| TypeScript  | Type definitions are included in the package.                                                   |
+| Web Workers | Browser bundle and [modular](#modular-variant) support.                                         |
 
 > [!NOTE]
 > Versions 1.2.x of the SDK support Internet Explorer >=9 and other older browsers, as well as Node.js >=8.17.
@@ -133,7 +133,7 @@ In order to further reduce bundle size, the modular variant of the SDK performs
 
 If you require more verbose logging, use the default variant of the SDK.
 
-For more information view the [TypeDoc references](https://sdk.ably.com/builds/ably/ably-js/main/typedoc/modules/modular.html).
+For more information view the [TypeDoc references](https://sdk.ably.com/builds/ably/ably-pubsub-js/main/typedoc/modules/modular.html).
 
 </details>
 
@@ -147,13 +147,13 @@ Read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to contribute to Ably.
 
 ## Releases
 
-The [CHANGELOG.md](/ably/ably-js/blob/main/CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
+The [CHANGELOG.md](/ably/ably-pubsub-js/blob/main/CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
 
 ---
 
 ## Support, feedback, and troubleshooting
 
-For help or technical support, visit Ably's [support page](https://ably.com/support) or [GitHub Issues](https://github.com/ably/ably-js-nativescript/issues) for community-reported bugs and discussions.
+For help or technical support, visit Ably's [support page](https://ably.com/support) or [GitHub Issues](https://github.com/ably/ably-pubsub-js/issues) for community-reported bugs and discussions.
 
 ### Chrome extensions
 
@@ -221,7 +221,7 @@ export default function AblyClientProvider({ children }) {
 }
 ```
 
-Avoid creating the client inside [React](https://github.com/ably/ably-js/blob/main/docs/react.md#Usage) component bodies, as this leads to a new connection on every render. Use the `useEffect` + `useState` pattern shown above, or move the client to a shared provider at the layout level.
+Avoid creating the client inside [React](https://github.com/ably/ably-pubsub-js/blob/main/docs/react.md#Usage) component bodies, as this leads to a new connection on every render. Use the `useEffect` + `useState` pattern shown above, or move the client to a shared provider at the layout level.
 
 In development environments that use Hot Module Replacement (HMR), such as React, Vite, or Next.js, saving a file can recreate the Ably.Realtime client, while previous instances remain connected. Over time, this leads to a growing number of active connections with each code edit. To fix: Move the client to a separate file (e.g., `ably-client.js`) and import it. This ensures the client is recreated only when that file changes.
 

package.json

@@ -4,7 +4,7 @@
   "version": "2.28.0",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/ably/ably-js/issues",
+    "url": "https://github.com/ably/ably-pubsub-js/issues",
     "email": "support@ably.com"
   },
   "main": "./build/ably-node.js",
@@ -164,7 +164,7 @@
   "engines": {
     "node": ">=16"
   },
-  "repository": "ably/ably-js",
+  "repository": "ably/ably-pubsub-js",
   "jspm": {
     "registry": "npm",
     "directories": {

scripts/processPrivateApiData/utils.ts

@@ -5,7 +5,7 @@ import { StaticContext } from './staticContext';
 export function stripFilePrefix(records: Record[]) {
   for (const record of records) {
     if (record.context.file !== null) {
-      record.context.file = record.context.file.replace('/home/runner/work/ably-js/ably-js/', '');
+      record.context.file = record.context.file.replace('/home/runner/work/ably-pubsub-js/ably-pubsub-js/', '');
     }
   }
 }

src/common/lib/util/utils.ts

@@ -525,7 +525,7 @@ export function createMissingPluginError(pluginName: keyof ModularPlugins): Erro
         'Import { LiveObjects } from "ably/liveobjects" and pass it in ClientOptions.plugins: { LiveObjects }.';
       break;
     default:
-      remediation = `Import ${pluginName} from "ably/modular" and pass it in ClientOptions.plugins: { ${pluginName} }. See the modular variant reference at https://sdk.ably.com/builds/ably/ably-js/main/typedoc/modules/modular.html.`;
+      remediation = `Import ${pluginName} from "ably/modular" and pass it in ClientOptions.plugins: { ${pluginName} }. See the modular variant reference at https://sdk.ably.com/builds/ably/ably-pubsub-js/main/typedoc/modules/modular.html.`;
       break;
   }
   const err = new ErrorInfo({

src/fragments/license.js

@@ -4,6 +4,6 @@ const { version } = require('../../package.json');
 module.exports = `@license Copyright 2015-2022 Ably Real-time Ltd (ably.com)
 
 Ably JavaScript Library v${version}
-https://github.com/ably/ably-js
+https://github.com/ably/ably-pubsub-js
 
 Released under the Apache Licence v2.0`;