@feathersjs/socketio-client 5.0.0-pre.21 → 5.0.0-pre.24

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0-pre.24](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.23...v5.0.0-pre.24) (2022-06-21)
+
+
+### Features
+
+* **cli:** Add typed client to a generated app ([#2669](https://github.com/feathersjs/feathers/issues/2669)) ([5b801b5](https://github.com/feathersjs/feathers/commit/5b801b5017ddc3eaa95622b539f51d605916bc86))
+
+
+
+
+
+# [5.0.0-pre.23](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.22...v5.0.0-pre.23) (2022-06-06)
+
+
+### Features
+
+* **client:** Improve client side custom method support ([#2654](https://github.com/feathersjs/feathers/issues/2654)) ([c138acf](https://github.com/feathersjs/feathers/commit/c138acf50affbe6b66177d084d3c7a3e9220f09f))
+
+
+
+
+
+# [5.0.0-pre.22](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.21...v5.0.0-pre.22) (2022-05-24)
+
+**Note:** Version bump only for package @feathersjs/socketio-client
+
+
+
+
+
 # [5.0.0-pre.21](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.20...v5.0.0-pre.21) (2022-05-23)
 
 **Note:** Version bump only for package @feathersjs/socketio-client

package/lib/index.d.ts

@@ -1,8 +1,14 @@
-import { Service, SocketService } from '@feathersjs/transport-commons/client';
+import { SocketService } from '@feathersjs/transport-commons/client';
 import { Socket } from 'socket.io-client';
+import { TransportConnection } from '@feathersjs/feathers';
 export { SocketService };
-export default function socketioClient(connection: Socket, options?: any): {
-    (app: any): void;
-    Service: typeof Service;
-    service: (this: any, name: string) => Service<any, Partial<any>>;
-};
+declare module '@feathersjs/feathers/lib/declarations' {
+    interface FeathersApplication<Services, Settings> {
+        /**
+         * The Socket.io client instance. Usually does not need
+         * to be accessed directly.
+         */
+        io?: Socket;
+    }
+}
+export default function socketioClient<Services = any>(connection: Socket, options?: any): TransportConnection<Services>;

package/lib/index.js

@@ -22,6 +22,12 @@ function socketioClient(connection, options) {
         }
         app.io = connection;
         app.defaultService = defaultService;
+        app.mixins.unshift((service, _location, options) => {
+            if (options && options.methods && service instanceof client_1.Service) {
+                const customMethods = options.methods.filter((name) => !feathers_1.defaultServiceMethods.includes(name));
+                service.methods(...customMethods);
+            }
+        });
     };
     initialize.Service = client_1.Service;
     initialize.service = defaultService;

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,iEAA8E;AAE9E,mDAAuD;AAIvD,SAAwB,cAAc,CAAE,UAAkB,EAAE,OAAa;IACvE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAC9D;IAED,MAAM,cAAc,GAAG,UAAqB,IAAY;QACtD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,0BAAe,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;YAC1C,MAAM;YACN,IAAI;YACJ,UAAU;YACV,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QAEH,OAAO,IAAI,gBAAO,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,UAAU,GAAQ;QACnC,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACvE;QAED,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC;QACpB,GAAG,CAAC,cAAc,GAAG,cAAc,CAAC;IACtC,CAAC,CAAC;IAEF,UAAU,CAAC,OAAO,GAAG,gBAAO,CAAC;IAC7B,UAAU,CAAC,OAAO,GAAG,cAAc,CAAC;IAEpC,OAAO,UAAU,CAAC;AACpB,CAAC;AA9BD,iCA8BC;AAED,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;CAChE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,iEAA6E;AAE7E,mDAK6B;AAc7B,SAAwB,cAAc,CAAiB,UAAkB,EAAE,OAAa;IACtF,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;KAC7D;IAED,MAAM,cAAc,GAAG,UAAqB,IAAY;QACtD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,0BAAe,CAAC,CAAA;QAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;YAC1C,MAAM;YACN,IAAI;YACJ,UAAU;YACV,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;QAEF,OAAO,IAAI,gBAAO,CAAC,QAAQ,CAAQ,CAAA;IACrC,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,UAAU,GAA0B;QACrD,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;SACtE;QAED,GAAG,CAAC,EAAE,GAAG,UAAiB,CAAA;QAC1B,GAAG,CAAC,cAAc,GAAG,cAAc,CAAA;QACnC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE;YACjD,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,YAAY,gBAAO,EAAE;gBAC5D,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,gCAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;gBAE7F,OAAO,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,CAAA;aAClC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,UAAU,CAAC,OAAO,GAAG,gBAAO,CAAA;IAC5B,UAAU,CAAC,OAAO,GAAG,cAAc,CAAA;IAEnC,OAAO,UAA2C,CAAA;AACpD,CAAC;AArCD,iCAqCC;AAED,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;CAC/D"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/socketio-client",
   "description": "The client for Socket.io through feathers-socketio",
-  "version": "5.0.0-pre.21",
+  "version": "5.0.0-pre.24",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -53,21 +53,21 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/transport-commons": "^5.0.0-pre.21"
+    "@feathersjs/transport-commons": "^5.0.0-pre.24"
   },
   "devDependencies": {
-    "@feathersjs/commons": "^5.0.0-pre.20",
-    "@feathersjs/feathers": "^5.0.0-pre.21",
-    "@feathersjs/memory": "^5.0.0-pre.21",
-    "@feathersjs/socketio": "^5.0.0-pre.21",
-    "@feathersjs/tests": "^5.0.0-pre.21",
+    "@feathersjs/commons": "^5.0.0-pre.24",
+    "@feathersjs/feathers": "^5.0.0-pre.24",
+    "@feathersjs/memory": "^5.0.0-pre.24",
+    "@feathersjs/socketio": "^5.0.0-pre.24",
+    "@feathersjs/tests": "^5.0.0-pre.24",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.31",
+    "@types/node": "^17.0.40",
     "mocha": "^10.0.0",
     "shx": "^0.3.4",
-    "socket.io-client": "^4.5.0",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.4"
+    "socket.io-client": "^4.5.1",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.3"
   },
-  "gitHead": "ac3baed231f72370a80a06c5944538915479b96e"
+  "gitHead": "72779fa2938f43d7b345b6861ff0035481a07de3"
 }

package/src/index.ts

@@ -1,41 +1,63 @@
-import { Service, SocketService } from '@feathersjs/transport-commons/client';
-import { Socket } from 'socket.io-client';
-import { defaultEventMap } from '@feathersjs/feathers';
-
-export { SocketService };
+import { Service, SocketService } from '@feathersjs/transport-commons/client'
+import { Socket } from 'socket.io-client'
+import {
+  Application,
+  TransportConnection,
+  defaultEventMap,
+  defaultServiceMethods
+} from '@feathersjs/feathers'
+
+export { SocketService }
+
+declare module '@feathersjs/feathers/lib/declarations' {
+  interface FeathersApplication<Services, Settings> {
+    /**
+     * The Socket.io client instance. Usually does not need
+     * to be accessed directly.
+     */
+    io?: Socket
+  }
+}
 
-export default function socketioClient (connection: Socket, options?: any) {
+export default function socketioClient<Services = any>(connection: Socket, options?: any) {
   if (!connection) {
-    throw new Error('Socket.io connection needs to be provided');
+    throw new Error('Socket.io connection needs to be provided')
   }
 
   const defaultService = function (this: any, name: string) {
-    const events = Object.values(defaultEventMap);
+    const events = Object.values(defaultEventMap)
     const settings = Object.assign({}, options, {
       events,
       name,
       connection,
       method: 'emit'
-    });
+    })
 
-    return new Service(settings);
-  };
+    return new Service(settings) as any
+  }
 
-  const initialize = function (app: any) {
+  const initialize = function (app: Application<Services>) {
     if (app.io !== undefined) {
-      throw new Error('Only one default client provider can be configured');
+      throw new Error('Only one default client provider can be configured')
     }
 
-    app.io = connection;
-    app.defaultService = defaultService;
-  };
+    app.io = connection as any
+    app.defaultService = defaultService
+    app.mixins.unshift((service, _location, options) => {
+      if (options && options.methods && service instanceof Service) {
+        const customMethods = options.methods.filter((name) => !defaultServiceMethods.includes(name))
+
+        service.methods(...customMethods)
+      }
+    })
+  }
 
-  initialize.Service = Service;
-  initialize.service = defaultService;
+  initialize.Service = Service
+  initialize.service = defaultService
 
-  return initialize;
+  return initialize as TransportConnection<Services>
 }
 
 if (typeof module !== 'undefined') {
-  module.exports = Object.assign(socketioClient, module.exports);
+  module.exports = Object.assign(socketioClient, module.exports)
 }