foldkit-primitives 0.1.0

package/dist/device/index.d.mts

@@ -0,0 +1,312 @@
+import { Option, Queue, Schema, Stream } from "effect";
+import { Bundle } from "foldkit-bundle";
+import * as ManagedResource from "foldkit/managedResource";
+import { Command } from "foldkit/command";
+//#region src/device/fullscreen.d.ts
+export declare const FullscreenMessage: import("foldkit/message").MessageUnion<{
+  readonly Changed: {
+    readonly active: Schema.Boolean;
+  };
+  readonly Entered: {};
+  readonly Exited: {};
+  readonly Failed: {
+    readonly message: Schema.String;
+  };
+}>;
+export type FullscreenMessage = typeof FullscreenMessage.Type;
+/**
+ * Requests fullscreen for an element. The capability is feature-checked on
+ * the element itself (SVG and HTML elements both qualify), falling back to
+ * the legacy `webkit` prefix; a platform with neither yields `Failed`
+ * instead of throwing.
+ */
+export declare const enterFullscreen: (element: Element) => Command<FullscreenMessage, never, never>;
+/** Leaves fullscreen, with the same legacy fallback. Without a document API it yields `Failed`, not a throw. */
+export declare const exitFullscreen: () => Command<FullscreenMessage, never, never>;
+/**
+ * `Changed` whenever fullscreen state flips, starting with the current
+ * answer. Without a document the stream is empty instead of throwing.
+ */
+export declare const fullscreenChanges: () => Stream.Stream<FullscreenMessage>;
+//#endregion
+//#region src/device/geolocation.d.ts
+export declare const Coordinates: Schema.Struct<{
+  readonly latitude: Schema.Number;
+  readonly longitude: Schema.Number;
+  readonly accuracy: Schema.Number;
+}>;
+export type Coordinates = typeof Coordinates.Type;
+export declare const GeolocationModel: Schema.Struct<{
+  readonly status: Schema.Literals<readonly ["unknown", "ready", "denied"]>;
+  readonly coords: Schema.NullOr<Schema.Struct<{
+    readonly latitude: Schema.Number;
+    readonly longitude: Schema.Number;
+    readonly accuracy: Schema.Number;
+  }>>;
+  readonly lastError: Schema.NullOr<Schema.String>;
+}>;
+export type GeolocationModel = typeof GeolocationModel.Type;
+export declare const GeolocationMessage: import("foldkit/message").MessageUnion<{
+  readonly Located: {
+    readonly latitude: Schema.Number;
+    readonly longitude: Schema.Number;
+    readonly accuracy: Schema.Number;
+  };
+  readonly Denied: {};
+  readonly Failed: {
+    readonly message: Schema.String;
+  };
+}>;
+export type GeolocationMessage = typeof GeolocationMessage.Type;
+export declare const Geolocation: Bundle.Bundle<"Geolocation", void, {
+  readonly status: "unknown" | "denied" | "ready";
+  readonly coords: {
+    readonly latitude: number;
+    readonly longitude: number;
+    readonly accuracy: number;
+  } | null;
+  readonly lastError: string | null;
+}, {
+  readonly _tag: "Failed";
+  readonly message: string;
+} | {
+  readonly _tag: "Located";
+  readonly latitude: number;
+  readonly longitude: number;
+  readonly accuracy: number;
+} | {
+  readonly _tag: "Denied";
+}, never, never, never, void, {}, {}>;
+//#endregion
+//#region src/device/media-devices.d.ts
+export declare const MediaDevice: Schema.Struct<{
+  readonly deviceId: Schema.String;
+  readonly groupId: Schema.String;
+  readonly kind: Schema.Literals<readonly ["audioinput", "audiooutput", "videoinput"]>;
+  readonly label: Schema.String;
+}>;
+export type MediaDevice = typeof MediaDevice.Type;
+export declare const MediaDevicesModel: Schema.Struct<{
+  readonly status: Schema.Literals<readonly ["unknown", "ready", "denied"]>;
+  readonly devices: Schema.$Array<Schema.Struct<{
+    readonly deviceId: Schema.String;
+    readonly groupId: Schema.String;
+    readonly kind: Schema.Literals<readonly ["audioinput", "audiooutput", "videoinput"]>;
+    readonly label: Schema.String;
+  }>>;
+  readonly lastError: Schema.NullOr<Schema.String>;
+}>;
+export type MediaDevicesModel = typeof MediaDevicesModel.Type;
+export declare const MediaDevicesMessage: import("foldkit/message").MessageUnion<{
+  readonly Scan: {};
+  readonly DevicesChanged: {};
+  readonly Refreshed: {
+    readonly devices: Schema.$Array<Schema.Struct<{
+      readonly deviceId: Schema.String;
+      readonly groupId: Schema.String;
+      readonly kind: Schema.Literals<readonly ["audioinput", "audiooutput", "videoinput"]>;
+      readonly label: Schema.String;
+    }>>;
+  };
+  readonly Denied: {};
+  readonly Failed: {
+    readonly message: Schema.String;
+  };
+}>;
+export type MediaDevicesMessage = typeof MediaDevicesMessage.Type;
+/** The slice of MediaDevices the bundle needs; satisfied by the platform object. */
+export interface MediaDevicesHandle {
+  enumerateDevices(): Promise<ReadonlyArray<{
+    readonly deviceId: string;
+    readonly groupId: string;
+    readonly kind: string;
+    readonly label: string;
+  }>>;
+  addEventListener(type: string, listener: () => void): void;
+  removeEventListener(type: string, listener: () => void): void;
+}
+export declare const mediaDevices: <const Name extends string>(config: {
+  readonly name: Name;
+  /** Read lazily so tests can substitute a double, like the SSE bundle. */
+  readonly create?: ((navigator: Navigator) => MediaDevicesHandle | null) | undefined;
+}) => Bundle.Bundle<Name, void, {
+  readonly status: "unknown" | "denied" | "ready";
+  readonly devices: readonly {
+    readonly deviceId: string;
+    readonly groupId: string;
+    readonly kind: "audioinput" | "audiooutput" | "videoinput";
+    readonly label: string;
+  }[];
+  readonly lastError: string | null;
+}, {
+  readonly _tag: "Denied";
+} | {
+  readonly _tag: "Failed";
+  readonly message: string;
+} | {
+  readonly _tag: "Scan";
+} | {
+  readonly _tag: "DevicesChanged";
+} | {
+  readonly _tag: "Refreshed";
+  readonly devices: readonly {
+    readonly deviceId: string;
+    readonly groupId: string;
+    readonly kind: "audioinput" | "audiooutput" | "videoinput";
+    readonly label: string;
+  }[];
+}, never, never, never, void, {}, {}>;
+//#endregion
+//#region src/device/media-stream.d.ts
+export declare const MediaStreamModel: Schema.Struct<{
+  readonly status: Schema.Literals<readonly ["idle", "requesting", "live", "denied"]>;
+  readonly lastError: Schema.NullOr<Schema.String>;
+}>;
+export type MediaStreamModel = typeof MediaStreamModel.Type;
+export declare const MediaStreamMessage: import("foldkit/message").MessageUnion<{
+  readonly Started: {};
+  readonly Stopped: {};
+  readonly Live: {};
+  readonly Ended: {};
+  readonly Denied: {};
+  readonly Failed: {
+    readonly message: Schema.String;
+  };
+}>;
+export type MediaStreamMessage = typeof MediaStreamMessage.Type;
+/** A single media track: stopped on release. */
+export interface MediaTrackHandle {
+  stop(): void;
+}
+/** The live stream: its tracks stop on release. */
+export interface MediaStreamHandle {
+  getTracks(): ReadonlyArray<MediaTrackHandle>;
+}
+export interface MediaStreamConstraints {
+  readonly audio: boolean;
+  readonly video: boolean;
+}
+/** The live stream, for commands that attach it to an element. One assembly holds one. */
+export declare const LiveStream: ManagedResource.ManagedResource<MediaStreamHandle, ManagedResource.ManagedResourceService<"media-stream">>;
+/** The stream service a placed camera requires. */
+export type LiveStreamService = ManagedResource.ServiceOf<typeof LiveStream>;
+export declare const mediaStream: <const Name extends string>(config: {
+  readonly name: Name;
+  /** Read lazily so tests can substitute a double, like the SSE bundle. */
+  readonly request?: ((constraints: MediaStreamConstraints) => Promise<MediaStreamHandle>) | undefined;
+}) => Bundle.Bundle<Name, {
+  readonly audio: boolean;
+  readonly video: boolean;
+}, {
+  readonly status: "denied" | "idle" | "requesting" | "live";
+  readonly lastError: string | null;
+}, {
+  readonly _tag: "Started";
+} | {
+  readonly _tag: "Stopped";
+} | {
+  readonly _tag: "Denied";
+} | {
+  readonly _tag: "Live";
+} | {
+  readonly _tag: "Failed";
+  readonly message: string;
+} | {
+  readonly _tag: "Ended";
+}, never, never, never, void, {
+  stream: ManagedResource.Entry<{
+    readonly status: "denied" | "idle" | "requesting" | "live";
+    readonly lastError: string | null;
+  }, {
+    readonly _tag: "Started";
+  } | {
+    readonly _tag: "Stopped";
+  } | {
+    readonly _tag: "Denied";
+  } | {
+    readonly _tag: "Live";
+  } | {
+    readonly _tag: "Failed";
+    readonly message: string;
+  } | {
+    readonly _tag: "Ended";
+  }, Option.Option<{
+    readonly audio: boolean;
+    readonly video: boolean;
+  }>, MediaStreamHandle, ManagedResource.ManagedResourceService<"media-stream">, () => {
+    readonly _tag: "Live";
+  }>;
+}, {}>;
+//#endregion
+//#region src/device/permissions.d.ts
+export declare const PermissionState: Schema.Literals<readonly ["granted", "denied", "prompt"]>;
+export type PermissionState = typeof PermissionState.Type;
+export declare const PermissionsModel: Schema.Struct<{
+  readonly states: Schema.$Record<Schema.String, Schema.Literals<readonly ["granted", "denied", "prompt"]>>;
+  readonly lastError: Schema.NullOr<Schema.String>;
+}>;
+export type PermissionsModel = typeof PermissionsModel.Type;
+export declare const PermissionsMessage: import("foldkit/message").MessageUnion<{
+  readonly Snapshot: {
+    readonly states: Schema.$Record<Schema.String, Schema.Literals<readonly ["granted", "denied", "prompt"]>>;
+  };
+  readonly Changed: {
+    readonly name: Schema.String;
+    readonly state: Schema.Literals<readonly ["granted", "denied", "prompt"]>;
+  };
+  readonly Cleared: {};
+  readonly Failed: {
+    readonly message: Schema.String;
+  };
+}>;
+export type PermissionsMessage = typeof PermissionsMessage.Type;
+/** A queried permission status; `onchange` fires while watched. */
+export interface PermissionStatusHandle {
+  readonly state: string;
+  onchange: (() => void) | null;
+}
+/** The slice of the Permissions API the bundle needs. */
+export interface PermissionsHandle {
+  query(descriptor: {
+    readonly name: string;
+  }): Promise<PermissionStatusHandle>;
+}
+interface Acquired {
+  readonly statuses: ReadonlyMap<string, PermissionStatusHandle>;
+  readonly snapshot: Readonly<Record<string, PermissionState>>;
+  readonly events: Queue.Queue<PermissionsMessage>;
+}
+/** The watched statuses, for the changes subscription. One assembly holds one. */
+export declare const Watch: ManagedResource.ManagedResource<Acquired, ManagedResource.ManagedResourceService<"permissions">>;
+/** The watch service a placed Permissions bundle requires. */
+export type WatchService = ManagedResource.ServiceOf<typeof Watch>;
+export declare const permissions: <const Name extends string>(config: {
+  readonly name: Name;
+  /** Read lazily so tests can substitute a double, like the SSE bundle. */
+  readonly create?: ((navigator: Navigator) => PermissionsHandle | null) | undefined;
+}) => Bundle.Bundle<Name, {
+  readonly names: ReadonlyArray<string>;
+}, {
+  readonly states: {
+    readonly [x: string]: "granted" | "denied" | "prompt";
+  };
+  readonly lastError: string | null;
+}, {
+  readonly _tag: "Changed";
+  readonly name: string;
+  readonly state: "granted" | "denied" | "prompt";
+} | {
+  readonly _tag: "Failed";
+  readonly message: string;
+} | {
+  readonly _tag: "Snapshot";
+  readonly states: {
+    readonly [x: string]: "granted" | "denied" | "prompt";
+  };
+} | {
+  readonly _tag: "Cleared";
+}, never, never, ManagedResource.ManagedResourceService<"permissions">, void, Readonly<{
+  watch: ManagedResource.Entry<PermissionsModel, PermissionsMessage, Option.Option<ReadonlyArray<string>>, Acquired, WatchService, (acquired: Acquired) => PermissionsMessage>;
+}>, {}>;
+//#endregion
+//# sourceMappingURL=index.d.mts.map

package/dist/device/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/device/fullscreen.ts","../../src/device/geolocation.ts","../../src/device/media-devices.ts","../../src/device/media-stream.ts","../../src/device/permissions.ts"],"mappings":";;;;;qBAWa,6CAAiB;;;;;;;;;;YAMlB,2BAA2B,kBAAkB;;;;;;;qBAW5C,kBAAe,SAAa,YAAU,QAAQ;;qBA0B9C,sBAAqB,QAAQ;;;;;qBAgC7B,yBAAwB,OAAO,OAAO;;;qBC1EtC,aAAW,OAAA;;;;;YAKZ,qBAAqB,YAAY;qBAEhC,kBAAgB,OAAA;;;;;;;;;YAKjB,0BAA0B,iBAAiB;qBAE1C,8CAAkB;;;;;;;;;;;YASnB,4BAA4B,mBAAmB;qBAmD9C,aAAW,OAAA;;;;;;;;;;;;;;;;;;;;;qBCzEX,aAAW,OAAA;;;;;;YAMZ,qBAAqB,YAAY;qBAEhC,mBAAiB,OAAA;;;;;;;;;;YAKlB,2BAA2B,kBAAkB;qBAE5C,+CAAmB;;;;;;;;;;;;;;;;YAOpB,6BAA6B,oBAAoB;;iBAG5C;EACf,oBAAoB,QAClB;aACW;aACA;aACA;aACA;;EAGb,iBAAiB,cAAc;EAC/B,oBAAoB,cAAc;;qBAUvB,qBAAsB,qBAAmB;WAC3C,MAAM;;WAEN,WAAW,WAAW,cAAc;MAC9C,OAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBC/CY,kBAAgB,OAAA;;;;YAIjB,0BAA0B,iBAAiB;qBAE1C,8CAAkB;;;;;;;sBAAlB,OAAA;;;YAQD,4BAA4B,mBAAmB;;iBAG1C;EACf;;;iBAIe;EACf,aAAa,cAAc;;iBAGZ;WACN;WACA;;;qBAIE,YAAU,gBAAA,gBAAA,mBAAA,gBAAA;;YAGX,oBAAoB,gBAAgB,iBAAiB;qBAoBpD,oBAAqB,qBAAmB;WAC1C,MAAM;;WAEN,YACL,aAAa,2BAA2B,QAAQ;MACrD,OAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBC5DY,iBAAe,OAAA;YAChB,yBAAyB,gBAAgB;qBAExC,kBAAgB,OAAA;;;;YAIjB,0BAA0B,iBAAiB;qBAE1C,8CAAkB;;;;;;;;;;;;;YAMnB,4BAA4B,mBAAmB;;iBAG1C;WACN;EACT;;;iBAIe;EACf,MAAM;aAAuB;MAAiB,QAAQ;;UAG9C;WACC,UAAU,oBAAoB;WAC9B,UAAU,SAAS,eAAe;WAClC,QAAQ,MAAM,MAAM;;;qBAIlB,OAAK,gBAAA,gBAAA,UAAA,gBAAA;;YAGN,eAAe,gBAAgB,iBAAiB;qBAuB/C,oBAAqB,qBAAmB;WAC1C,MAAM;;WAEN,WAAW,WAAW,cAAc;MAC9C,OAAA,OAAA;WAYqB,OAAA;;;;;;;;;;;;;;;;;;;;;EApCb,OAAA,gBAAgB,MACrB,kBACA,oBACA,OAAO,OAAO,wBACd,UACA,eACC,UAAU,aAAa"}