@pie-players/tts-client-server 0.3.4 → 0.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -38,6 +38,19 @@ await ttsService.initialize(provider, {
38
38
  voiceId: 'Joanna',
39
39
  language: 'en-US',
40
40
  });
41
+
42
+ // Note: `apiEndpoint`, `provider`, and `voiceId` are server-provider-specific
43
+ // options. When using TTSConfig, pass these inside `providerOptions` rather
44
+ // than as top-level fields:
45
+ //
46
+ // const config: TTSConfig = {
47
+ // providerOptions: {
48
+ // apiEndpoint: '/api/tts',
49
+ // provider: 'polly',
50
+ // voiceId: 'Joanna',
51
+ // },
52
+ // language: 'en-US',
53
+ // };
41
54
  ```
42
55
 
43
56
  ### With Authentication
@@ -117,7 +130,7 @@ The server API must implement two endpoints:
117
130
 
118
131
  ## SvelteKit Implementation Example
119
132
 
120
- See the implementation guide in [tts-server-api-architecture.md](../../docs/tts-server-api-architecture.md).
133
+ See the implementation guide in [tts-architecture.md](../../docs/accessibility/tts-architecture.md).
121
134
 
122
135
  Example route structure:
123
136
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pie-players/tts-client-server",
3
- "version": "0.3.4",
3
+ "version": "0.3.7",
4
4
  "description": "Client-side TTS provider that calls server API for synthesis",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -38,7 +38,7 @@
38
38
  "access": "public"
39
39
  },
40
40
  "dependencies": {
41
- "@pie-players/pie-tts": "0.3.4"
41
+ "@pie-players/pie-tts": "0.3.7"
42
42
  },
43
43
  "devDependencies": {
44
44
  "typescript": "^5.9.3",