lecodes-sdk 2.2.9 → 2.2.11

package/dist/types/plugins/gen/audio-recorder/sdk/audio-recorder.d.ts

@@ -0,0 +1,43 @@
+import { Emitter } from "../../../../plugin";
+import type { EndReason, RecordOptions, Recording } from "../contract";
+export type { EndReason, RecordOptions, Recording };
+/** `"stopped"` = the recording ended on its own (`ended` fired): `stop()` still returns it. */
+export type RecorderState = "inactive" | "recording" | "paused" | "stopped";
+export type AudioRecorderEvents = {
+    /** The input level, 0..1, about ten times a second while recording — a meter, a waveform. */
+    level: (value: number) => void;
+    /** The recording stopped on its own: the limit, an interruption (a call came in), a failure.
+     *  `stop()` returns what was recorded. */
+    ended: (reason: EndReason) => void;
+};
+/**
+ * Records the microphone to a file. `AudioRecorder.isSupported` reports whether this host
+ * registered the service — check it before showing a record button.
+ *
+ * ```ts
+ * const recorder = new AudioRecorder()
+ * recorder.addEventListener('level', v => meter.style({ width: v * 100 }))
+ * await recorder.start({ maxDuration: 60_000 })
+ * const { file, duration, mimeType } = await recorder.stop()
+ * ```
+ */
+export declare class AudioRecorder extends Emitter<AudioRecorderEvents> {
+    /** Whether this host registered an "audioRecorder" service. */
+    static get isSupported(): boolean;
+    private _session;
+    private _state;
+    get state(): RecorderState;
+    /** Start a recording. The host asks for the microphone first; rejects `"denied"` when refused,
+     *  `"failed"` when the recorder could not start, and before touching the host when it is not
+     *  supported or a recording is under way. */
+    start(options?: RecordOptions): Promise<void>;
+    /** Pause: the level stops, the duration does not grow. */
+    pause(): Promise<void>;
+    resume(): Promise<void>;
+    /** Stop and get the recording — also after `ended`. Rejects `"failed"` when nothing could be
+     *  encoded. The recorder is ready for another `start()` afterwards. */
+    stop(): Promise<Recording>;
+    /** Stop and discard. Nothing under way is not an error. */
+    cancel(): void;
+    private _drop;
+}

package/dist/types/plugins/gen/audio-recorder/sdk/audio-recorder.gen.d.ts

@@ -0,0 +1,47 @@
+import { ServiceChannel } from "../../../../plugin";
+import type { AudioRecorderEvents, AudioRecorderParams, RecordOptions, Recording } from "../contract";
+/** What the halves register under. */
+export declare const NAME = "audioRecorder";
+/** The contract's version: the highest `@since` of its members. */
+export declare const VERSION = 1;
+/** Start recording. One recording per session: a second start rejects "busy".
+ *  Needs the "microphone" permission: the host asks before the call, "denied" when refused.
+ *  Rejects with "denied" / "busy" / "failed". */
+export declare const start: (service: ServiceChannel<AudioRecorderEvents>, options?: RecordOptions) => Promise<void>;
+/** Pause: the level stops, the duration does not grow. Rejects "notRecording" before a start
+ *  or after the recording ended.
+ *  Rejects with "notRecording" / "failed". */
+export declare const pause: (service: ServiceChannel<AudioRecorderEvents>) => Promise<void>;
+/** Rejects with "notRecording" / "failed". */
+export declare const resume: (service: ServiceChannel<AudioRecorderEvents>) => Promise<void>;
+/** Stop and get the recording (also after `ended`: the file was kept). Rejects "failed" when
+ *  nothing could be encoded.
+ *  Rejects with "notRecording" / "failed". */
+export declare const stop: (service: ServiceChannel<AudioRecorderEvents>) => Promise<Recording>;
+/** Stop and discard. Nothing to discard is not an error. */
+export declare const cancel: (service: ServiceChannel<AudioRecorderEvents>) => Promise<void>;
+/** A method of the contract. */
+export type Method = "start" | "pause" | "resume" | "stop" | "cancel";
+/** Whether this host has the service "audioRecorder" — and, given a method, a half new enough for it
+ *  (a method added after the first version of the contract is tagged `@since`). */
+export declare const supports: (method?: Method) => boolean;
+/** The service "audioRecorder" with the wire's methods as its own. */
+export declare class AudioRecorderBase extends ServiceChannel<AudioRecorderEvents> {
+    constructor(params?: AudioRecorderParams);
+    /** Start recording. One recording per session: a second start rejects "busy".
+     *  Needs the "microphone" permission: the host asks before the call, "denied" when refused.
+     *  Rejects with "denied" / "busy" / "failed". */
+    start(options?: RecordOptions): Promise<void>;
+    /** Pause: the level stops, the duration does not grow. Rejects "notRecording" before a start
+     *  or after the recording ended.
+     *  Rejects with "notRecording" / "failed". */
+    pause(): Promise<void>;
+    /** Rejects with "notRecording" / "failed". */
+    resume(): Promise<void>;
+    /** Stop and get the recording (also after `ended`: the file was kept). Rejects "failed" when
+     *  nothing could be encoded.
+     *  Rejects with "notRecording" / "failed". */
+    stop(): Promise<Recording>;
+    /** Stop and discard. Nothing to discard is not an error. */
+    cancel(): Promise<void>;
+}

package/dist/types/plugins/gen/geolocation/sdk/geolocation.gen.d.ts

@@ -5,10 +5,12 @@ export declare const NAME = "geolocation";
 /** The contract's version: the highest `@since` of its members. */
 export declare const VERSION = 1;
 /** One fix.
+ *  Needs the "location" permission: the host asks before the call, "denied" when refused.
  *  Rejects with "denied" / "unavailable" / "timeout". */
 export declare const getCurrent: (service: ServiceChannel<GeolocationEvents>, options?: GeoOptions) => Promise<GeoPosition>;
-/** Start the session's watch; resolves once it is live (permission granted, provider started).
+/** Start the session's watch; resolves once it is live (the provider started).
  *  A second call while watching resolves at once and keeps the first call's options.
+ *  Needs the "location" permission: the host asks before the call, "denied" when refused.
  *  Rejects with "denied" / "unavailable". */
 export declare const startWatch: (service: ServiceChannel<GeolocationEvents>, options?: GeoOptions) => Promise<void>;
 export declare const stopWatch: (service: ServiceChannel<GeolocationEvents>) => Promise<void>;
@@ -21,10 +23,12 @@ export declare const supports: (method?: Method) => boolean;
 export declare class GeolocationBase extends ServiceChannel<GeolocationEvents> {
     constructor(params?: GeolocationParams);
     /** One fix.
+     *  Needs the "location" permission: the host asks before the call, "denied" when refused.
      *  Rejects with "denied" / "unavailable" / "timeout". */
     getCurrent(options?: GeoOptions): Promise<GeoPosition>;
-    /** Start the session's watch; resolves once it is live (permission granted, provider started).
+    /** Start the session's watch; resolves once it is live (the provider started).
      *  A second call while watching resolves at once and keeps the first call's options.
+     *  Needs the "location" permission: the host asks before the call, "denied" when refused.
      *  Rejects with "denied" / "unavailable". */
     startWatch(options?: GeoOptions): Promise<void>;
     stopWatch(): Promise<void>;

package/dist/types/plugins/gen/speech/sdk/speech.d.ts

@@ -0,0 +1,44 @@
+import { Emitter } from "../../../../plugin";
+import type { SpeechErrorCode, SpeechOptions, SpeechResult } from "../contract";
+export type { SpeechErrorCode, SpeechOptions, SpeechResult };
+export type SpeechRecognizerEvents = {
+    /** A result: partials while the user speaks (`interimResults`), then the final one. */
+    result: (result: SpeechResult) => void;
+    /** The user started speaking. */
+    speechStart: () => void;
+    /** The user stopped speaking: the final result follows. */
+    speechEnd: () => void;
+    /** The listening is over — after the final result, after `stop()` / `abort()`, after an error. */
+    end: () => void;
+    /** The listening failed; `end` follows. */
+    error: (code: SpeechErrorCode, message: string) => void;
+};
+/**
+ * Recognizes speech from the microphone. `SpeechRecognizer.isSupported` reports whether this host
+ * registered the service — check it before showing a dictation button.
+ *
+ * ```ts
+ * const speech = new SpeechRecognizer()
+ * speech.addEventListener('result', r => input.value = r.transcript)
+ * speech.addEventListener('end', () => micButton.style({ opacity: 1 }))
+ * await speech.start({ language: 'en-US' })
+ * ```
+ */
+export declare class SpeechRecognizer extends Emitter<SpeechRecognizerEvents> {
+    /** Whether this host registered a "speech" service. */
+    static get isSupported(): boolean;
+    private _session;
+    /** Whether a listening is under way. */
+    get listening(): boolean;
+    /** Start listening. The host asks for the permissions first; rejects `"denied"` when refused,
+     *  `"unavailable"` when there is no recognizer for the language or on the device, and before
+     *  touching the host when the plugin is not there or a listening is under way. */
+    start(options?: SpeechOptions): Promise<void>;
+    /** Stop listening and finish: the final result of what was heard, then `end`. */
+    stop(): void;
+    /** Stop and drop what was heard: `end`, no result. */
+    abort(): void;
+    /** The languages this host recognizes (BCP-47), sorted; empty when it cannot say (the web). */
+    static supportedLanguages(): Promise<string[]>;
+    private _drop;
+}

package/dist/types/plugins/gen/speech/sdk/speech.gen.d.ts

@@ -0,0 +1,39 @@
+import { ServiceChannel } from "../../../../plugin";
+import type { SpeechEvents, SpeechOptions, SpeechParams } from "../contract";
+/** What the halves register under. */
+export declare const NAME = "speech";
+/** The contract's version: the highest `@since` of its members. */
+export declare const VERSION = 1;
+/** Start listening. One listening per session: a second start rejects "busy". "unavailable":
+ *  no recognizer on this device, or none for the language / on the device.
+ *  Needs the "speech" and "microphone" permissions: the host asks before the call, "denied" when refused.
+ *  Rejects with "denied" / "busy" / "unavailable" / "failed". */
+export declare const start: (service: ServiceChannel<SpeechEvents>, options?: SpeechOptions) => Promise<void>;
+/** Stop listening and finish: the final result of what was heard, then `end`. Not listening is
+ *  not an error. */
+export declare const stop: (service: ServiceChannel<SpeechEvents>) => Promise<void>;
+/** Stop and drop what was heard: `end`, no result. */
+export declare const abort: (service: ServiceChannel<SpeechEvents>) => Promise<void>;
+/** The languages this host recognizes, BCP-47; empty when the host cannot say (the web). */
+export declare const supportedLanguages: (service: ServiceChannel<SpeechEvents>) => Promise<string[]>;
+/** A method of the contract. */
+export type Method = "start" | "stop" | "abort" | "supportedLanguages";
+/** Whether this host has the service "speech" — and, given a method, a half new enough for it
+ *  (a method added after the first version of the contract is tagged `@since`). */
+export declare const supports: (method?: Method) => boolean;
+/** The service "speech" with the wire's methods as its own. */
+export declare class SpeechBase extends ServiceChannel<SpeechEvents> {
+    constructor(params?: SpeechParams);
+    /** Start listening. One listening per session: a second start rejects "busy". "unavailable":
+     *  no recognizer on this device, or none for the language / on the device.
+     *  Needs the "speech" and "microphone" permissions: the host asks before the call, "denied" when refused.
+     *  Rejects with "denied" / "busy" / "unavailable" / "failed". */
+    start(options?: SpeechOptions): Promise<void>;
+    /** Stop listening and finish: the final result of what was heard, then `end`. Not listening is
+     *  not an error. */
+    stop(): Promise<void>;
+    /** Stop and drop what was heard: `end`, no result. */
+    abort(): Promise<void>;
+    /** The languages this host recognizes, BCP-47; empty when the host cannot say (the web). */
+    supportedLanguages(): Promise<string[]>;
+}

package/dist/types/runtime/media.d.ts

@@ -1,5 +1,6 @@
 import { Emitter } from "../core/events";
 import { Texture } from "../gl/Texture";
+import type { File, FetchResponse } from "./fetch";
 type MediaEvents = {
     /** Fired at each loop boundary while `loop` is true. */
     loopReached: () => void;
@@ -32,10 +33,10 @@ declare abstract class MediaPlayer extends Emitter<MediaEvents> {
     dispose(): void;
 }
 export declare class AudioPlayer extends MediaPlayer {
-    constructor(src?: string);
+    constructor(src?: string | File | FetchResponse);
 }
 export declare class VideoPlayer extends MediaPlayer {
-    constructor(src?: string);
+    constructor(src?: string | File | FetchResponse);
     /** A 3D Texture that samples this video (e.g. for a Material.video()). Owned by the player. */
     get texture(): Texture;
 }

package/dist/types/runtime/permissions.d.ts

@@ -0,0 +1,16 @@
+export type PermissionKind = "camera" | "microphone" | "location" | "speech";
+/** "prompt" = never asked: `request` shows the dialog. "denied" = refused, or restricted by the
+ *  device's policy; the OS decides whether a `request` asks again (iOS never does: `openSettings`). */
+export type PermissionState = "granted" | "denied" | "prompt";
+export declare const permissions: {
+    /** The state of `kind` without a prompt. On the web the browser may not know before a request
+     *  (Safari before 16, Firefox for the camera): "prompt" then. */
+    query(kind: PermissionKind): Promise<PermissionState>;
+    /** Ask for `kind`: the dialog when it was never asked, the state after it (or the state as it
+     *  stands when the OS will not ask again). Ask where the user expects it — the first tap on the
+     *  record button, not the start of the call. */
+    request(kind: PermissionKind): Promise<PermissionState>;
+    /** Open the app's own page of the system settings: where a denied permission is turned back on
+     *  (iOS asks exactly once). A no-op where there is no such page (web). */
+    openSettings(): void;
+};

package/dist/types/version.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "2.2.9";
+export declare const SDK_VERSION = "2.2.11";
 /** The major of a semver string, or null when it is not one. */
 export declare const sdkMajor: (version: string | null | undefined) => number | null;
 /** The `// sdk: <version>` line of a compiled bundle's header (sdk/src/compile/header.ts), read from