Rename "LiveObjects" file names to just "Objects"

VeskeR · VeskeR · commit b5b04b96f46a · 2025-03-05T07:25:04.000Z
diff --git a/grunt/esbuild/build.js b/grunt/esbuild/build.js
@@ -79,22 +79,22 @@ const minifiedPushPluginCdnConfig = {
 
 const objectsPluginConfig = {
   ...createBaseConfig(),
-  entryPoints: ['src/plugins/liveobjects/index.ts'],
+  entryPoints: ['src/plugins/objects/index.ts'],
   plugins: [umdWrapper.default({ libraryName: 'AblyObjectsPlugin', amdNamedModule: false })],
   outfile: 'build/objects.js',
   external: ['deep-equal'],
 };
 
 const objectsPluginCdnConfig = {
   ...createBaseConfig(),
-  entryPoints: ['src/plugins/liveobjects/index.ts'],
+  entryPoints: ['src/plugins/objects/index.ts'],
   plugins: [umdWrapper.default({ libraryName: 'AblyObjectsPlugin', amdNamedModule: false })],
   outfile: 'build/objects.umd.js',
 };
 
 const minifiedObjectsPluginCdnConfig = {
   ...createBaseConfig(),
-  entryPoints: ['src/plugins/liveobjects/index.ts'],
+  entryPoints: ['src/plugins/objects/index.ts'],
   plugins: [umdWrapper.default({ libraryName: 'AblyObjectsPlugin', amdNamedModule: false })],
   outfile: 'build/objects.umd.min.js',
   minify: true,
diff --git a/objects.d.ts b/objects.d.ts
diff --git a/package.json b/package.json
@@ -31,14 +31,14 @@
       "import": "./build/push.js"
     },
     "./objects": {
-      "types": "./liveobjects.d.ts",
+      "types": "./objects.d.ts",
       "import": "./build/objects.js"
     }
   },
   "files": [
     "build/**",
     "ably.d.ts",
-    "liveobjects.d.ts",
+    "objects.d.ts",
     "modular.d.ts",
     "push.d.ts",
     "resources/**",
diff --git a/scripts/moduleReport.ts b/scripts/moduleReport.ts
@@ -323,18 +323,18 @@ async function checkObjectsPluginFiles() {
 
   // These are the files that are allowed to contribute >= `threshold` bytes to the Objects bundle.
   const allowedFiles = new Set([
-    'src/plugins/liveobjects/batchcontext.ts',
-    'src/plugins/liveobjects/batchcontextlivecounter.ts',
-    'src/plugins/liveobjects/batchcontextlivemap.ts',
-    'src/plugins/liveobjects/index.ts',
-    'src/plugins/liveobjects/livecounter.ts',
-    'src/plugins/liveobjects/livemap.ts',
-    'src/plugins/liveobjects/liveobject.ts',
-    'src/plugins/liveobjects/liveobjects.ts',
-    'src/plugins/liveobjects/liveobjectspool.ts',
-    'src/plugins/liveobjects/objectid.ts',
-    'src/plugins/liveobjects/statemessage.ts',
-    'src/plugins/liveobjects/syncliveobjectsdatapool.ts',
+    'src/plugins/objects/batchcontext.ts',
+    'src/plugins/objects/batchcontextlivecounter.ts',
+    'src/plugins/objects/batchcontextlivemap.ts',
+    'src/plugins/objects/index.ts',
+    'src/plugins/objects/livecounter.ts',
+    'src/plugins/objects/livemap.ts',
+    'src/plugins/objects/liveobject.ts',
+    'src/plugins/objects/objectid.ts',
+    'src/plugins/objects/objects.ts',
+    'src/plugins/objects/objectspool.ts',
+    'src/plugins/objects/statemessage.ts',
+    'src/plugins/objects/syncobjectsdatapool.ts',
   ]);
 
   return checkBundleFiles(pluginBundleInfo, allowedFiles, 100);
diff --git a/src/common/lib/client/baserealtime.ts b/src/common/lib/client/baserealtime.ts
@@ -13,7 +13,7 @@ import { ModularPlugins, RealtimePresencePlugin } from './modularplugins';
 import { TransportNames } from 'common/constants/TransportName';
 import { TransportImplementations } from 'common/platform';
 import Defaults from '../util/defaults';
-import type * as ObjectsPlugin from 'plugins/liveobjects';
+import type * as ObjectsPlugin from 'plugins/objects';
 
 /**
  `BaseRealtime` is an export of the tree-shakable version of the SDK, and acts as the base class for the `DefaultRealtime` class exported by the non tree-shakable version.
diff --git a/src/common/lib/client/modularplugins.ts b/src/common/lib/client/modularplugins.ts
@@ -11,7 +11,7 @@ import {
 } from '../types/presencemessage';
 import { TransportCtor } from '../transport/transport';
 import type * as PushPlugin from 'plugins/push';
-import type * as ObjectsPlugin from 'plugins/liveobjects';
+import type * as ObjectsPlugin from 'plugins/objects';
 
 export interface PresenceMessagePlugin {
   presenceMessageFromValues: typeof presenceMessageFromValues;
diff --git a/src/common/lib/client/realtimechannel.ts b/src/common/lib/client/realtimechannel.ts
@@ -30,7 +30,7 @@ import { ChannelOptions } from '../../types/channel';
 import { normaliseChannelOptions } from '../util/defaults';
 import { PaginatedResult } from './paginatedresource';
 import type { PushChannel } from 'plugins/push';
-import type { Objects, StateMessage } from 'plugins/liveobjects';
+import type { Objects, StateMessage } from 'plugins/objects';
 
 interface RealtimeHistoryParams {
   start?: number;
diff --git a/src/common/lib/types/protocolmessage.ts b/src/common/lib/types/protocolmessage.ts
@@ -12,7 +12,7 @@ import PresenceMessage, {
   fromValues as presenceMessageFromValues,
   fromValuesArray as presenceMessagesFromValuesArray,
 } from './presencemessage';
-import type * as ObjectsPlugin from 'plugins/liveobjects';
+import type * as ObjectsPlugin from 'plugins/objects';
 
 export const actions = {
   HEARTBEAT: 0,
diff --git a/src/plugins/index.d.ts b/src/plugins/index.d.ts
@@ -1,4 +1,4 @@
-import Objects from './liveobjects';
+import Objects from './objects';
 import Push from './push';
 
 export interface StandardPlugins {
diff --git a/src/plugins/objects/batchcontext.ts b/src/plugins/objects/batchcontext.ts
@@ -4,8 +4,8 @@ import { BatchContextLiveCounter } from './batchcontextlivecounter';
 import { BatchContextLiveMap } from './batchcontextlivemap';
 import { LiveCounter } from './livecounter';
 import { LiveMap } from './livemap';
-import { Objects } from './liveobjects';
-import { ROOT_OBJECT_ID } from './liveobjectspool';
+import { Objects } from './objects';
+import { ROOT_OBJECT_ID } from './objectspool';
 import { StateMessage } from './statemessage';
 
 export class BatchContext {
diff --git a/src/plugins/objects/batchcontextlivecounter.ts b/src/plugins/objects/batchcontextlivecounter.ts
@@ -1,7 +1,7 @@
 import type BaseClient from 'common/lib/client/baseclient';
 import { BatchContext } from './batchcontext';
 import { LiveCounter } from './livecounter';
-import { Objects } from './liveobjects';
+import { Objects } from './objects';
 
 export class BatchContextLiveCounter {
   private _client: BaseClient;
diff --git a/src/plugins/objects/batchcontextlivemap.ts b/src/plugins/objects/batchcontextlivemap.ts
@@ -2,7 +2,7 @@ import type * as API from '../../../ably';
 import { BatchContext } from './batchcontext';
 import { LiveMap } from './livemap';
 import { LiveObject } from './liveobject';
-import { Objects } from './liveobjects';
+import { Objects } from './objects';
 
 export class BatchContextLiveMap<T extends API.LiveMapType> {
   constructor(
diff --git a/src/plugins/objects/defaults.ts b/src/plugins/objects/defaults.ts
diff --git a/src/plugins/objects/index.ts b/src/plugins/objects/index.ts
@@ -1,4 +1,4 @@
-import { Objects } from './liveobjects';
+import { Objects } from './objects';
 import { StateMessage } from './statemessage';
 
 export { Objects, StateMessage };
diff --git a/src/plugins/objects/livecounter.ts b/src/plugins/objects/livecounter.ts
@@ -1,6 +1,6 @@
 import { LiveObject, LiveObjectData, LiveObjectUpdate, LiveObjectUpdateNoop } from './liveobject';
-import { Objects } from './liveobjects';
 import { ObjectId } from './objectid';
+import { Objects } from './objects';
 import { StateCounterOp, StateMessage, StateObject, StateOperation, StateOperationAction } from './statemessage';
 
 export interface LiveCounterData extends LiveObjectData {
diff --git a/src/plugins/objects/livemap.ts b/src/plugins/objects/livemap.ts
@@ -3,8 +3,8 @@ import deepEqual from 'deep-equal';
 import type * as API from '../../../ably';
 import { DEFAULTS } from './defaults';
 import { LiveObject, LiveObjectData, LiveObjectUpdate, LiveObjectUpdateNoop } from './liveobject';
-import { Objects } from './liveobjects';
 import { ObjectId } from './objectid';
+import { Objects } from './objects';
 import {
   MapSemantics,
   StateMapEntry,
diff --git a/src/plugins/objects/liveobject.ts b/src/plugins/objects/liveobject.ts
@@ -1,6 +1,6 @@
 import type BaseClient from 'common/lib/client/baseclient';
 import type EventEmitter from 'common/lib/util/eventemitter';
-import { Objects } from './liveobjects';
+import { Objects } from './objects';
 import { StateMessage, StateObject, StateOperation } from './statemessage';
 
 export enum LiveObjectSubscriptionEvent {
diff --git a/src/plugins/objects/objectid.ts b/src/plugins/objects/objectid.ts
diff --git a/src/plugins/objects/objects.ts b/src/plugins/objects/objects.ts
@@ -7,9 +7,9 @@ import { DEFAULTS } from './defaults';
 import { LiveCounter } from './livecounter';
 import { LiveMap } from './livemap';
 import { LiveObject, LiveObjectUpdate, LiveObjectUpdateNoop } from './liveobject';
-import { ObjectsPool, ROOT_OBJECT_ID } from './liveobjectspool';
+import { ObjectsPool, ROOT_OBJECT_ID } from './objectspool';
 import { StateMessage, StateOperationAction } from './statemessage';
-import { SyncObjectsDataPool } from './syncliveobjectsdatapool';
+import { SyncObjectsDataPool } from './syncobjectsdatapool';
 
 export enum ObjectsEvent {
   syncing = 'syncing',
diff --git a/src/plugins/objects/objectspool.ts b/src/plugins/objects/objectspool.ts
@@ -3,8 +3,8 @@ import { DEFAULTS } from './defaults';
 import { LiveCounter } from './livecounter';
 import { LiveMap } from './livemap';
 import { LiveObject } from './liveobject';
-import { Objects } from './liveobjects';
 import { ObjectId } from './objectid';
+import { Objects } from './objects';
 
 export const ROOT_OBJECT_ID = 'root';
 
diff --git a/src/plugins/objects/statemessage.ts b/src/plugins/objects/statemessage.ts
diff --git a/src/plugins/objects/syncobjectsdatapool.ts b/src/plugins/objects/syncobjectsdatapool.ts
@@ -1,6 +1,6 @@
 import type BaseClient from 'common/lib/client/baseclient';
 import type RealtimeChannel from 'common/lib/client/realtimechannel';
-import { Objects } from './liveobjects';
+import { Objects } from './objects';
 import { StateMessage, StateObject } from './statemessage';
 
 export interface LiveObjectDataEntry {
diff --git a/test/common/globals/named_dependencies.js b/test/common/globals/named_dependencies.js
@@ -28,8 +28,8 @@ define(function () {
       node: 'test/common/modules/private_api_recorder',
     },
     objects_helper: {
-      browser: 'test/common/modules/live_objects_helper',
-      node: 'test/common/modules/live_objects_helper',
+      browser: 'test/common/modules/objects_helper',
+      node: 'test/common/modules/objects_helper',
     },
   });
 });
diff --git a/test/common/modules/objects_helper.js b/test/common/modules/objects_helper.js
diff --git a/test/package/browser/template/README.md b/test/package/browser/template/README.md
@@ -8,7 +8,7 @@ This directory is intended to be used for testing the following aspects of the a
 It contains three files, each of which import ably-js in different manners, and provide a way to briefly exercise its functionality:
 
 - `src/index-default.ts` imports the default ably-js package (`import { Realtime } from 'ably'`).
-- `src/index-liveobjects.ts` imports the Objects ably-js plugin (`import Objects from 'ably/objects'`).
+- `src/index-objects.ts` imports the Objects ably-js plugin (`import Objects from 'ably/objects'`).
 - `src/index-modular.ts` imports the tree-shakable ably-js package (`import { BaseRealtime, WebSocketTransport, FetchRequest } from 'ably/modular'`).
 - `src/ReactApp.tsx` imports React hooks from the ably-js package (`import { useChannel } from 'ably/react'`).
 
@@ -26,7 +26,7 @@ This directory exposes three package scripts that are to be used for testing:
 
 - `build`: Uses esbuild to create:
   1. a bundle containing `src/index-default.ts` and ably-js;
-  2. a bundle containing `src/index-liveobjects.ts` and ably-js.
+  2. a bundle containing `src/index-objects.ts` and ably-js.
   3. a bundle containing `src/index-modular.ts` and ably-js.
 - `test`: Using the bundles created by `build` and playwright components setup, tests that the code that exercises ably-js’s functionality is working correctly in a browser.
 - `typecheck`: Type-checks the code that imports ably-js.
diff --git a/test/package/browser/template/package.json b/test/package/browser/template/package.json
@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "build": "esbuild --bundle src/index-default.ts --outdir=dist && esbuild --bundle src/index-liveobjects.ts --outdir=dist && esbuild --bundle src/index-modular.ts --outdir=dist",
+    "build": "esbuild --bundle src/index-default.ts --outdir=dist && esbuild --bundle src/index-objects.ts --outdir=dist && esbuild --bundle src/index-modular.ts --outdir=dist",
     "typecheck": "tsc --project src -noEmit",
     "test-support:server": "ts-node server/server.ts",
     "test": "npm run test:lib && npm run test:hooks",
diff --git a/test/package/browser/template/server/resources/index-objects.html b/test/package/browser/template/server/resources/index-objects.html
@@ -5,7 +5,7 @@
     <title>Ably NPM package test (Objects plugin export)</title>
   </head>
   <body>
-    <script type="text/javascript" src="index-liveobjects.js"></script>
+    <script type="text/javascript" src="index-objects.js"></script>
     <script type="text/javascript" src="runTest.js"></script>
   </body>
 </html>
diff --git a/test/package/browser/template/server/server.ts b/test/package/browser/template/server/server.ts
@@ -5,7 +5,7 @@ async function startWebServer(listenPort: number) {
   const server = express();
   server.get('/', (req, res) => res.send('OK'));
   server.use(express.static(path.join(__dirname, '/resources')));
-  for (const filename of ['index-default.js', 'index-liveobjects.js', 'index-modular.js']) {
+  for (const filename of ['index-default.js', 'index-objects.js', 'index-modular.js']) {
     server.use(`/${filename}`, express.static(path.join(__dirname, '..', 'dist', filename)));
   }
 
diff --git a/test/package/browser/template/src/index-objects.ts b/test/package/browser/template/src/index-objects.ts
diff --git a/test/package/browser/template/test/lib/package.test.ts b/test/package/browser/template/test/lib/package.test.ts
@@ -3,7 +3,7 @@ import { test, expect } from '@playwright/test';
 test.describe('NPM package', () => {
   for (const scenario of [
     { name: 'default export', path: '/index-default.html' },
-    { name: 'Objects plugin export', path: '/index-liveobjects.html' },
+    { name: 'Objects plugin export', path: '/index-objects.html' },
     { name: 'modular export', path: '/index-modular.html' },
   ]) {
     test.describe(scenario.name, () => {
diff --git a/test/realtime/objects.test.js b/test/realtime/objects.test.js
diff --git a/test/support/browser_file_list.js b/test/support/browser_file_list.js
@@ -39,7 +39,7 @@ window.__testFiles__.files = {
   'test/realtime/failure.test.js': true,
   'test/realtime/history.test.js': true,
   'test/realtime/init.test.js': true,
-  'test/realtime/live_objects.test.js': true,
+  'test/realtime/objects.test.js': true,
   'test/realtime/message.test.js': true,
   'test/realtime/presence.test.js': true,
   'test/realtime/reauth.test.js': true,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import Objects from './liveobjects';`
	`1`	`+import Objects from './objects';`
`2`	`2`	`import Push from './push';`
`3`	`3`
`4`	`4`	`export interface StandardPlugins {`