@simonpeacocks/peacockery-voice-client 0.1.2 → 0.1.3
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.
- package/README.md +19 -1
- package/dist/schema.d.ts +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,4 +23,22 @@ For a device-bound child, pass `authorizationScheme: "DPoP"` and a platform proo
|
|
|
23
23
|
|
|
24
24
|
Private-key creation and signing stay in platform code. On Apple hardware the intended provider uses a non-exportable Secure Enclave P-256 key; the generated client never serializes or persists that key.
|
|
25
25
|
|
|
26
|
-
Run `pnpm run generate:sdk` from the repository root whenever the OpenAPI contract changes. Compiled JavaScript and declarations are checked in
|
|
26
|
+
Run `pnpm run generate:sdk` from the repository root whenever the OpenAPI contract changes. Compiled JavaScript and declarations are checked in, and private Git installations consume them directly. Realtime WebSockets still use the protocol documented by `/v1/realtime`; `openapi-fetch` covers the HTTP surface.
|
|
27
|
+
|
|
28
|
+
## Release
|
|
29
|
+
|
|
30
|
+
Run one guarded command from a clean, synchronized `main` branch:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pnpm release:voice-client patch
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The command regenerates the SDK, validates the TypeScript client and Swift package when Swift is available, increments the requested semantic version, commits only generated client release files, creates the matching `voice-client-vX.Y.Z` tag, atomically pushes `main` and the tag, watches the GitHub Actions publication, and verifies the new npm version.
|
|
37
|
+
|
|
38
|
+
Use `minor`, `major`, or an explicit stable version in place of `patch`. Run the complete preflight while keeping the repository unchanged with:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pnpm release:voice-client patch --check
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
If GitHub Actions reports a provider-side failure after the atomic push, repair the publisher configuration and rerun that workflow. The existing version commit and release tag remain the canonical release identity.
|
package/dist/schema.d.ts
CHANGED
|
@@ -2029,6 +2029,7 @@ export interface components {
|
|
|
2029
2029
|
completed_at: string | null;
|
|
2030
2030
|
created_at: string;
|
|
2031
2031
|
error: string | null;
|
|
2032
|
+
error_details: components["schemas"]["ProviderFailureDiagnostic"];
|
|
2032
2033
|
job_id: string;
|
|
2033
2034
|
/** @enum {string} */
|
|
2034
2035
|
kind: "transcription";
|
|
@@ -2040,6 +2041,17 @@ export interface components {
|
|
|
2040
2041
|
status: "pending" | "queued" | "running" | "succeeded" | "failed";
|
|
2041
2042
|
updated_at: string;
|
|
2042
2043
|
};
|
|
2044
|
+
ProviderFailureDiagnostic: {
|
|
2045
|
+
/** @enum {string} */
|
|
2046
|
+
category: "authentication" | "empty_output" | "invalid_request" | "network" | "rate_limited" | "timeout" | "unavailable" | "unknown";
|
|
2047
|
+
message: string;
|
|
2048
|
+
provider?: string;
|
|
2049
|
+
providerCode?: string;
|
|
2050
|
+
requestId?: string;
|
|
2051
|
+
retryAfterMs?: number;
|
|
2052
|
+
retryable: boolean;
|
|
2053
|
+
statusCode?: number;
|
|
2054
|
+
} | null;
|
|
2043
2055
|
TranscriptionArtifact: {
|
|
2044
2056
|
content: {
|
|
2045
2057
|
audio_events: {
|