Skip to content

Commit ebbf24e

Browse files
daffldaffl
authored
chore: Update chat example to latest prerelease (#233)
1 parent 5f7fe23 commit ebbf24e

22 files changed

+629
-645
lines changed

‎feathers-chat-ts/config/default.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
},
1212
"sqlite": {
1313
"client": "sqlite3",
14-
"connection": "./feathers-chat.sqlite",
14+
"connection": "feathers-chat.sqlite",
1515
"useNullAsDefault": true
1616
},
1717
"authentication": {
1818
"entity": "user",
1919
"service": "users",
20-
"secret": "l5GBmnEYr9TsQbUXXtkyMJTwW6Yu2wJV",
20+
"secret": "gQLBW0MvbM5rT/CPw8L2heJa8z8vGmme",
2121
"authStrategies": [
2222
"jwt",
2323
"local"
@@ -36,8 +36,8 @@
3636
},
3737
"oauth": {
3838
"github": {
39-
"key": "<Client ID>",
40-
"secret": "<Client secret>"
39+
"key": "7507f1495d162e6d9f8b",
40+
"secret": "22b491c057aa88a75bfa2f291f8b1f4c68fd413a"
4141
}
4242
}
4343
}

‎feathers-chat-ts/migrations/20230104220356_user.ts ‎feathers-chat-ts/migrations/20230129204709_user.ts

File renamed without changes.

‎feathers-chat-ts/migrations/20230104220406_authentication.ts ‎feathers-chat-ts/migrations/20230129204719_authentication.ts

File renamed without changes.

‎feathers-chat-ts/migrations/20230104220805_message.ts ‎feathers-chat-ts/migrations/20230129210755_message.ts

File renamed without changes.

‎feathers-chat-ts/migrations/20230104223942_chat.ts ‎feathers-chat-ts/migrations/20230129213438_chat.ts

File renamed without changes.

‎feathers-chat-ts/package-lock.json

+490-576
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎feathers-chat-ts/package.json

+21-20
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
},
3131
"files": [
3232
"lib/client.js",
33-
"lib/**/*.d.ts"
33+
"lib/**/*.d.ts",
34+
"lib/**/*.shared.js"
3435
],
3536
"main": "lib/client",
3637
"scripts": {
@@ -45,34 +46,34 @@
4546
"migrate:make": "knex migrate:make"
4647
},
4748
"dependencies": {
48-
"@feathersjs/adapter-commons": "^5.0.0-pre.34",
49-
"@feathersjs/authentication": "^5.0.0-pre.34",
50-
"@feathersjs/authentication-client": "^5.0.0-pre.34",
51-
"@feathersjs/authentication-local": "^5.0.0-pre.34",
52-
"@feathersjs/authentication-oauth": "^5.0.0-pre.34",
53-
"@feathersjs/configuration": "^5.0.0-pre.34",
54-
"@feathersjs/errors": "^5.0.0-pre.34",
55-
"@feathersjs/feathers": "^5.0.0-pre.34",
56-
"@feathersjs/knex": "^5.0.0-pre.34",
57-
"@feathersjs/koa": "^5.0.0-pre.34",
58-
"@feathersjs/schema": "^5.0.0-pre.34",
59-
"@feathersjs/socketio": "^5.0.0-pre.34",
60-
"@feathersjs/transport-commons": "^5.0.0-pre.34",
61-
"@feathersjs/typebox": "^5.0.0-pre.34",
62-
"knex": "^2.3.0",
49+
"@feathersjs/adapter-commons": "^5.0.0-pre.36",
50+
"@feathersjs/authentication": "^5.0.0-pre.36",
51+
"@feathersjs/authentication-client": "^5.0.0-pre.36",
52+
"@feathersjs/authentication-local": "^5.0.0-pre.36",
53+
"@feathersjs/authentication-oauth": "^5.0.0-pre.36",
54+
"@feathersjs/configuration": "^5.0.0-pre.36",
55+
"@feathersjs/errors": "^5.0.0-pre.36",
56+
"@feathersjs/feathers": "^5.0.0-pre.36",
57+
"@feathersjs/knex": "^5.0.0-pre.36",
58+
"@feathersjs/koa": "^5.0.0-pre.36",
59+
"@feathersjs/schema": "^5.0.0-pre.36",
60+
"@feathersjs/socketio": "^5.0.0-pre.36",
61+
"@feathersjs/transport-commons": "^5.0.0-pre.36",
62+
"@feathersjs/typebox": "^5.0.0-pre.36",
63+
"knex": "^2.4.2",
6364
"sqlite3": "^5.1.4",
6465
"winston": "^3.8.2"
6566
},
6667
"devDependencies": {
67-
"@feathersjs/cli": "^5.0.0-pre.34",
68-
"@feathersjs/rest-client": "^5.0.0-pre.34",
68+
"@feathersjs/cli": "^5.0.0-pre.36",
69+
"@feathersjs/rest-client": "^5.0.0-pre.36",
6970
"@types/mocha": "^10.0.1",
7071
"@types/node": "^18.11.18",
71-
"axios": "^1.2.2",
72+
"axios": "^1.2.6",
7273
"cross-env": "^7.0.3",
7374
"mocha": "^10.2.0",
7475
"nodemon": "^2.0.20",
75-
"prettier": "^2.8.1",
76+
"prettier": "^2.8.3",
7677
"shx": "^0.3.4",
7778
"ts-node": "^10.9.1",
7879
"typescript": "^4.9.4"

‎feathers-chat-ts/src/channels.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// For more information about this file see https://dove.feathersjs.com/guides/cli/channels.html
22
import type { RealTimeConnection, Params } from '@feathersjs/feathers'
3+
import type { AuthenticationResult } from '@feathersjs/authentication'
34
import '@feathersjs/transport-commons'
45
import type { Application, HookContext } from './declarations'
56
import { logger } from './logger'
@@ -11,15 +12,15 @@ export const channels = (app: Application) => {
1112
}
1213

1314
logger.warn(
14-
'Publishing all events to all authenticated users. See `channels.ts` and https://docs.feathersjs.com/api/channels.html for more information.'
15+
'Publishing all events to all authenticated users. See `channels.ts` and https://dove.feathersjs.com/api/channels.html for more information.'
1516
)
1617

17-
app.on('connection', (connection: any) => {
18+
app.on('connection', (connection: RealTimeConnection) => {
1819
// On a new real-time connection, add it to the anonymous channel
1920
app.channel('anonymous').join(connection)
2021
})
2122

22-
app.on('login', (authResult: any, { connection }: Params) => {
23+
app.on('login', (authResult: AuthenticationResult, { connection }: Params) => {
2324
// connection can be undefined if there is no
2425
// real-time connection, e.g. when logging in via REST
2526
if (connection) {

‎feathers-chat-ts/src/client.ts

+15-22
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
// For more information about this file see https://dove.feathersjs.com/guides/cli/client.html
22
import { feathers } from '@feathersjs/feathers'
3-
import type { TransportConnection, Params } from '@feathersjs/feathers'
3+
import type { TransportConnection, Application } from '@feathersjs/feathers'
44
import authenticationClient from '@feathersjs/authentication-client'
5-
import type { Message, MessageData, MessageQuery, MessageService } from './services/messages/messages'
6-
export type { Message, MessageData, MessageQuery }
7-
8-
import type { User, UserData, UserQuery, UserService } from './services/users/users'
9-
export type { User, UserData, UserQuery }
10-
115
import type { AuthenticationClientOptions } from '@feathersjs/authentication-client'
126

13-
const userServiceMethods = ['find', 'get', 'create', 'update', 'patch', 'remove'] as const
14-
type UserClientService = Pick<UserService<Params<UserQuery>>, typeof userServiceMethods[number]>
7+
import { messageClient } from './services/messages/messages.shared'
8+
export type { Message, MessageData, MessageQuery, MessagePatch } from './services/messages/messages.shared'
159

16-
const messageServiceMethods = ['find', 'get', 'create', 'update', 'patch', 'remove'] as const
17-
type MessageClientService = Pick<MessageService<Params<MessageQuery>>, typeof messageServiceMethods[number]>
10+
import { userClient } from './services/users/users.shared'
11+
export type { User, UserData, UserQuery, UserPatch } from './services/users/users.shared'
1812

19-
export interface ServiceTypes {
20-
messages: MessageClientService
21-
users: UserClientService
22-
//
13+
export interface Configuration {
14+
connection: TransportConnection<ServiceTypes>
2315
}
2416

17+
export interface ServiceTypes {}
18+
19+
export type ClientApplication = Application<ServiceTypes, Configuration>
20+
2521
/**
2622
* Returns a typed client for the feathers-chat app.
2723
*
@@ -34,16 +30,13 @@ export const createClient = <Configuration = any>(
3430
connection: TransportConnection<ServiceTypes>,
3531
authenticationOptions: Partial<AuthenticationClientOptions> = {}
3632
) => {
37-
const client = feathers<ServiceTypes, Configuration>()
33+
const client: ClientApplication = feathers()
3834

3935
client.configure(connection)
4036
client.configure(authenticationClient(authenticationOptions))
37+
client.set('connection', connection)
4138

42-
client.use('users', connection.service('users'), {
43-
methods: userServiceMethods
44-
})
45-
client.use('messages', connection.service('messages'), {
46-
methods: messageServiceMethods
47-
})
39+
client.configure(userClient)
40+
client.configure(messageClient)
4841
return client
4942
}

‎feathers-chat-ts/src/hooks/log-error.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const logError = async (context: HookContext, next: NextFunction) => {
1010

1111
// Log validation errors
1212
if (error.data) {
13-
logger.error(error.data)
13+
logger.error('Data: %O', error.data)
1414
}
1515

1616
throw error

‎feathers-chat-ts/src/hooks/log-runtime.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import type { HookContext, NextFunction } from '../declarations'
2+
import { logger } from '../logger'
23

34
export const logRuntime = async (context: HookContext, next: NextFunction) => {
45
const startTime = Date.now()
56
// Run everything else (other hooks and service call)
67
await next()
78

89
const duration = Date.now() - startTime
9-
console.log(`Calling ${context.method} on ${context.path} took ${duration}ms`)
10+
logger.info(`Calling ${context.method} on ${context.path} took ${duration}ms`)
1011
}

‎feathers-chat-ts/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import { logger } from './logger'
44
const port = app.get('port')
55
const host = app.get('host')
66

7+
process.on('unhandledRejection', (reason, p) => logger.error('Unhandled Rejection at: Promise ', p, reason))
8+
79
app.listen(port).then(() => {
810
logger.info(`Feathers app listening on http://${host}:${port}`)
911
})

‎feathers-chat-ts/src/services/messages/messages.class.ts

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import type { KnexAdapterParams, KnexAdapterOptions } from '@feathersjs/knex'
66
import type { Application } from '../../declarations'
77
import type { Message, MessageData, MessagePatch, MessageQuery } from './messages.schema'
88

9+
export type { Message, MessageData, MessagePatch, MessageQuery }
10+
911
export interface MessageParams extends KnexAdapterParams<MessageQuery> {}
1012

1113
// By default calls the standard Knex adapter service methods but can be customized with your own functionality.

‎feathers-chat-ts/src/services/messages/messages.schema.ts

+16-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// For more information about this file see https://dove.feathersjs.com/guides/cli/service.schemas.html
22
import { resolve, virtual } from '@feathersjs/schema'
3-
import { Type, getDataValidator, getValidator, querySyntax } from '@feathersjs/typebox'
3+
import { Type, getValidator, querySyntax } from '@feathersjs/typebox'
44
import type { Static } from '@feathersjs/typebox'
55

66
import type { HookContext } from '../../declarations'
@@ -19,6 +19,7 @@ export const messageSchema = Type.Object(
1919
{ $id: 'Message', additionalProperties: false }
2020
)
2121
export type Message = Static<typeof messageSchema>
22+
export const messageValidator = getValidator(messageSchema, dataValidator)
2223
export const messageResolver = resolve<Message, HookContext>({
2324
user: virtual(async (message, context) => {
2425
// Associate the user that sent the message
@@ -33,7 +34,7 @@ export const messageDataSchema = Type.Pick(messageSchema, ['text'], {
3334
$id: 'MessageData'
3435
})
3536
export type MessageData = Static<typeof messageDataSchema>
36-
export const messageDataValidator = getDataValidator(messageDataSchema, dataValidator)
37+
export const messageDataValidator = getValidator(messageDataSchema, dataValidator)
3738
export const messageDataResolver = resolve<Message, HookContext>({
3839
userId: async (_value, _message, context) => {
3940
// Associate the record with the id of the authenticated user
@@ -45,11 +46,11 @@ export const messageDataResolver = resolve<Message, HookContext>({
4546
})
4647

4748
// Schema for updating existing entries
48-
export const messagePatchSchema = Type.Partial(messageDataSchema, {
49+
export const messagePatchSchema = Type.Partial(messageSchema, {
4950
$id: 'MessagePatch'
5051
})
5152
export type MessagePatch = Static<typeof messagePatchSchema>
52-
export const messagePatchValidator = getDataValidator(messagePatchSchema, dataValidator)
53+
export const messagePatchValidator = getValidator(messagePatchSchema, dataValidator)
5354
export const messagePatchResolver = resolve<Message, HookContext>({})
5455

5556
// Schema for allowed query properties
@@ -64,4 +65,14 @@ export const messageQuerySchema = Type.Intersect(
6465
)
6566
export type MessageQuery = Static<typeof messageQuerySchema>
6667
export const messageQueryValidator = getValidator(messageQuerySchema, queryValidator)
67-
export const messageQueryResolver = resolve<MessageQuery, HookContext>({})
68+
export const messageQueryResolver = resolve<MessageQuery, HookContext>({
69+
userId: async (value, user, context) => {
70+
// We want to be able to find all messages but
71+
// only let a user modify their own messages otherwise
72+
if (context.params.user && context.method !== 'find') {
73+
return context.params.user.id
74+
}
75+
76+
return value
77+
}
78+
})

‎feathers-chat-ts/src/services/messages/messages.shared.ts

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// For more information about this file see https://dove.feathersjs.com/guides/cli/service.shared.html
2+
import type { Params } from '@feathersjs/feathers'
3+
import type { ClientApplication } from '../../client'
4+
import type { Message, MessageData, MessagePatch, MessageQuery, MessageService } from './messages.class'
5+
6+
export type { Message, MessageData, MessagePatch, MessageQuery }
7+
8+
export type MessageClientService = Pick<MessageService<Params<MessageQuery>>, (typeof messageMethods)[number]>
9+
10+
export const messagePath = 'messages'
11+
12+
export const messageMethods = ['find', 'get', 'create', 'patch', 'remove'] as const
13+
14+
export const messageClient = (client: ClientApplication) => {
15+
const connection = client.get('connection')
16+
17+
client.use(messagePath, connection.service(messagePath), {
18+
methods: messageMethods
19+
})
20+
}
21+
22+
// Add this service to the client service type index
23+
declare module '../../client' {
24+
interface ServiceTypes {
25+
[messagePath]: MessageClientService
26+
}
27+
}

‎feathers-chat-ts/src/services/messages/messages.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import {
1616

1717
import type { Application } from '../../declarations'
1818
import { MessageService, getOptions } from './messages.class'
19+
import { messagePath, messageMethods } from './messages.shared'
1920
import { logRuntime } from '../../hooks/log-runtime'
2021

2122
export * from './messages.class'
@@ -24,14 +25,14 @@ export * from './messages.schema'
2425
// A configure function that registers the service and its hooks via `app.configure`
2526
export const message = (app: Application) => {
2627
// Register our service on the Feathers application
27-
app.use('messages', new MessageService(getOptions(app)), {
28+
app.use(messagePath, new MessageService(getOptions(app)), {
2829
// A list of all methods this service exposes externally
29-
methods: ['find', 'get', 'create', 'patch', 'remove'],
30+
methods: messageMethods,
3031
// You can add additional custom events to be sent to clients here
3132
events: []
3233
})
3334
// Initialize hooks
34-
app.service('messages').hooks({
35+
app.service(messagePath).hooks({
3536
around: {
3637
all: [
3738
logRuntime,
@@ -60,6 +61,6 @@ export const message = (app: Application) => {
6061
// Add this service to the service type index
6162
declare module '../../declarations' {
6263
interface ServiceTypes {
63-
messages: MessageService
64+
[messagePath]: MessageService
6465
}
6566
}

‎feathers-chat-ts/src/services/users/users.class.ts

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import type { KnexAdapterParams, KnexAdapterOptions } from '@feathersjs/knex'
66
import type { Application } from '../../declarations'
77
import type { User, UserData, UserPatch, UserQuery } from './users.schema'
88

9+
export type { User, UserData, UserPatch, UserQuery }
10+
911
export interface UserParams extends KnexAdapterParams<UserQuery> {}
1012

1113
// By default calls the standard Knex adapter service methods but can be customized with your own functionality.

‎feathers-chat-ts/src/services/users/users.schema.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// For more information about this file see https://dove.feathersjs.com/guides/cli/service.schemas.html
22
import crypto from 'crypto'
33
import { resolve } from '@feathersjs/schema'
4-
import { Type, getDataValidator, getValidator, querySyntax } from '@feathersjs/typebox'
4+
import { Type, getValidator, querySyntax } from '@feathersjs/typebox'
55
import type { Static } from '@feathersjs/typebox'
66
import { passwordHash } from '@feathersjs/authentication-local'
77

@@ -20,6 +20,7 @@ export const userSchema = Type.Object(
2020
{ $id: 'User', additionalProperties: false }
2121
)
2222
export type User = Static<typeof userSchema>
23+
export const userValidator = getValidator(userSchema, dataValidator)
2324
export const userResolver = resolve<User, HookContext>({})
2425

2526
export const userExternalResolver = resolve<User, HookContext>({
@@ -33,7 +34,7 @@ export const userDataSchema = Type.Pick(userSchema, ['email', 'password', 'githu
3334
additionalProperties: false
3435
})
3536
export type UserData = Static<typeof userDataSchema>
36-
export const userDataValidator = getDataValidator(userDataSchema, dataValidator)
37+
export const userDataValidator = getValidator(userDataSchema, dataValidator)
3738
export const userDataResolver = resolve<User, HookContext>({
3839
password: passwordHash({ strategy: 'local' }),
3940
avatar: async (value, user) => {
@@ -54,7 +55,7 @@ export const userPatchSchema = Type.Partial(userSchema, {
5455
$id: 'UserPatch'
5556
})
5657
export type UserPatch = Static<typeof userPatchSchema>
57-
export const userPatchValidator = getDataValidator(userPatchSchema, dataValidator)
58+
export const userPatchValidator = getValidator(userPatchSchema, dataValidator)
5859
export const userPatchResolver = resolve<User, HookContext>({
5960
password: passwordHash({ strategy: 'local' })
6061
})

0 commit comments

Comments
 (0)