@stacksjs/mobile 0.70.375

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# @stacksjs/mobile
+
+Craft-powered mobile APIs for Stacks and STX applications. The package keeps
+native capability detection, readiness, haptics, location, camera, sharing,
+secure storage, lifecycle, health, Live Activities, and watch connectivity
+behind one browser-safe interface.
+
+```ts
+import { haptics, isNativeMobile, location } from '@stacksjs/mobile'
+
+if (isNativeMobile())
+  await haptics.selection()
+
+const position = await location.getCurrentPosition()
+```
+
+The `health` facade reads authorized Apple Health or Android Health Connect
+metrics and writes completed workouts using one payload. `watchConnectivity`
+keeps companion controls and recording state synchronized without exposing
+platform bridge globals to application code.

package/dist/index.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Bundled TypeScript declarations
+ * Generated from 2 source files
+ */
+
+
+// From: src/index.ts
+export declare const biometrics: BiometricsApi;
+export declare const camera: CameraApi;
+export declare const device: DeviceApi;
+export declare const haptics: HapticsApi;
+export declare const lifecycle: LifecycleApi;
+export declare const location: LocationApi;
+export declare const notifications: NotificationsApi;
+export declare const permissions: PermissionsApi;
+export declare const secureStorage: SecureStorageApi;
+export declare const share: ShareApi;
+export declare const appReview: AppReviewApi;
+export declare function normalizeDeepLinkURL(value: unknown): string | null;
+export declare const deepLinks: DeepLinksApi;
+export declare const keepAwake: KeepAwakeApi;
+export declare const network: NetworkApi;
+export declare const pushNotifications: PushNotificationsApi;
+export declare const health: HealthApi;
+export declare const liveActivities: LiveActivitiesApi;
+export declare const watchConnectivity: WatchConnectivityApi;
+export declare function isNativeMobile(): boolean;
+export declare function onMobileReady(callback: (event: CraftReadyEvent) => void): () => void;
+export declare function withNativeFeedback<T>(action: () => T | Promise<T>): Promise<T>;
+export declare const mobile: unknown;
+
+// From: src/types.ts
+export declare interface DeviceInfo {
+  platform: 'ios' | 'android' | 'macos' | 'windows' | 'linux'
+  osVersion: string
+  model: string
+  manufacturer: string
+  deviceId: string
+  isTablet: boolean
+  screen?: { width: number, height: number, scale: number }
+  battery?: { level: number, isCharging: boolean }
+  network?: { type: 'wifi' | 'cellular' | 'ethernet' | 'none', isConnected: boolean }
+}
+export declare interface DeviceCapabilities {
+  camera: boolean
+  biometrics: boolean
+  nfc: boolean
+  bluetooth: boolean
+  gps: boolean
+  backgroundLocation?: boolean
+  accelerometer: boolean
+  gyroscope: boolean
+  haptics: boolean
+  ar: boolean
+  faceId: boolean
+  touchId: boolean
+}
+export type HapticStyle = 'light' | 'medium' | 'heavy' | 'soft' | 'rigid';
+export type HapticNotificationType = 'success' | 'warning' | 'error';
+export type PermissionType = | 'camera'
+  | 'microphone'
+  | 'photos'
+  | 'location'
+  | 'locationAlways'
+  | 'notifications'
+  | 'contacts'
+  | 'calendar'
+  | 'reminders'
+  | 'bluetooth'
+  | 'motion'
+  | 'health';
+export type PermissionStatus = 'granted' | 'denied' | 'undetermined' | 'restricted';
+export declare interface CameraOptions {
+  camera?: 'front' | 'back'
+  quality?: number
+  maxWidth?: number
+  maxHeight?: number
+  saveToGallery?: boolean
+}
+export declare interface PhotoResult {
+  base64: string
+  uri: string
+  width: number
+  height: number
+  mimeType: string
+}
+export type BiometricType = 'faceId' | 'touchId' | 'fingerprint' | 'face' | 'iris';
+export declare interface Location {
+  latitude: number
+  longitude: number
+  altitude?: number
+  accuracy: number
+  heading?: number
+  speed?: number
+  timestamp: number
+}
+export declare interface LocationOptions {
+  enableHighAccuracy?: boolean
+  timeout?: number
+  maximumAge?: number
+}
+export declare interface LocationRecordingState {
+  id: string | null
+  active: boolean
+  paused: boolean
+  startedAt: number | null
+  sampleCount?: number
+}
+export declare interface LocationRecordingResult extends LocationRecordingState {
+  locations: Location[]
+}
+export declare interface ShareOptions {
+  text?: string
+  url?: string
+  title?: string
+  files?: string[]
+}
+export type AppState = 'active' | 'inactive' | 'background';
+export declare interface NotificationOptions {
+  title: string
+  body?: string
+  badge?: number
+  sound?: string
+  data?: Record<string, unknown>
+  scheduleAt?: number
+}
+export declare interface DeviceApi {
+  getInfo: () => Promise<DeviceInfo>
+  getCapabilities: () => Promise<DeviceCapabilities>
+  isMobile: () => boolean
+  isIOS: () => boolean
+  isAndroid: () => boolean
+  getLocale: () => string
+  getTimezone: () => string
+}
+export declare interface HapticsApi {
+  impact: (style?: HapticStyle) => Promise<void>
+  notification: (type?: HapticNotificationType) => Promise<void>
+  selection: () => Promise<void>
+  vibrate: (pattern: number[]) => Promise<void>
+}
+export declare interface PermissionsApi {
+  check: (permission: PermissionType) => Promise<PermissionStatus>
+  request: (permission: PermissionType) => Promise<PermissionStatus>
+  checkMultiple: (permissions: PermissionType[]) => Promise<Record<PermissionType, PermissionStatus>>
+  requestMultiple: (permissions: PermissionType[]) => Promise<Record<PermissionType, PermissionStatus>>
+  openSettings: () => Promise<void>
+}
+export declare interface CameraApi {
+  takePicture: (options?: CameraOptions) => Promise<PhotoResult>
+  pickImage: () => Promise<PhotoResult>
+  pickMultiple: (options?: { maxCount?: number }) => Promise<PhotoResult[]>
+  isAvailable: () => Promise<boolean>
+}
+export declare interface BiometricsApi {
+  isAvailable: () => Promise<boolean>
+  getBiometricType: () => Promise<BiometricType | null>
+  authenticate: (reason: string) => Promise<boolean>
+}
+export declare interface SecureStorageApi {
+  set: (key: string, value: string) => Promise<void>
+  get: (key: string) => Promise<string | null>
+  delete: (key: string) => Promise<void>
+  clear: () => Promise<void>
+}
+export declare interface LocationApi {
+  getCurrentPosition: (options?: LocationOptions) => Promise<Location>
+  watchPosition: (callback: (location: Location) => void, options?: LocationOptions) => number
+  clearWatch: (watchId: number) => void
+  startRecording: (options?: LocationOptions) => Promise<LocationRecordingState>
+  pauseRecording: () => Promise<LocationRecordingState>
+  resumeRecording: () => Promise<LocationRecordingState>
+  stopRecording: () => Promise<LocationRecordingResult>
+  getRecordingState: () => Promise<LocationRecordingState>
+  readRecording: () => Promise<Location[]>
+}
+export declare interface ShareApi {
+  share: (options: ShareOptions) => Promise<void>
+  isAvailable: () => boolean
+}
+export declare interface LifecycleApi {
+  getState: () => AppState
+  onStateChange: (callback: (state: AppState) => void) => () => void
+}
+export declare interface NotificationsApi {
+  show: (options: NotificationOptions) => Promise<void>
+  schedule: (options: NotificationOptions) => Promise<void>
+  cancelAll: () => Promise<void>
+  setBadge: (count: number) => Promise<void>
+}
+export declare interface KeepAwakeApi {
+  enable: () => Promise<void>
+  disable: () => Promise<void>
+}
+export declare interface DeepLinksApi {
+  getInitialURL: () => Promise<string | null>
+  onLink: (callback: (url: string) => void) => () => void
+}
+export declare interface NetworkStatus {
+  type: 'wifi' | 'cellular' | 'ethernet' | 'none' | 'unknown'
+  isConnected: boolean
+}
+export declare interface NetworkApi {
+  getStatus: () => Promise<NetworkStatus>
+  onChange: (callback: (status: NetworkStatus) => void) => () => void
+}
+export declare interface AppReviewApi {
+  request: () => Promise<boolean>
+}
+export declare interface PushNotificationsApi {
+  register: () => Promise<string>
+  onToken: (callback: (token: string) => void) => () => void
+  onNotification: (callback: (data: Record<string, unknown>) => void) => () => void
+}
+export type HealthDataType = 'steps' | 'heartRate' | 'activeEnergy' | 'distance' | 'workouts';
+export declare interface HealthDataOptions {
+  startDate?: number
+  endDate?: number
+}
+export declare interface HealthDataResult {
+  value: number
+  unit: string
+}
+export type HealthWorkoutType = 'running' | 'walking' | 'hiking' | 'cycling';
+export declare interface HealthWorkoutLocation {
+  latitude: number
+  longitude: number
+  altitude?: number
+  accuracy?: number
+  timestamp: number
+}
+export declare interface HealthWorkout {
+  activityId: string
+  type: HealthWorkoutType
+  startDate: number
+  endDate: number
+  distanceMeters?: number
+  activeEnergyCalories?: number
+  locations?: HealthWorkoutLocation[]
+}
+export declare interface HealthWorkoutResult {
+  id: string
+}
+export declare interface HealthApi {
+  requestAuthorization: (types: HealthDataType[]) => Promise<boolean>
+  getData: (type: HealthDataType, options?: HealthDataOptions) => Promise<HealthDataResult>
+  saveWorkout: (workout: HealthWorkout) => Promise<HealthWorkoutResult>
+}
+export declare interface LiveActivityState {
+  status?: string
+  distanceMeters?: number
+  durationSeconds?: number
+  progress?: number
+}
+export declare interface LiveActivityOptions extends LiveActivityState {
+  activityId: string
+  title: string
+}
+export declare interface LiveActivitiesApi {
+  start: (options: LiveActivityOptions) => Promise<{ id: string }>
+  update: (state: LiveActivityState) => Promise<void>
+  end: () => Promise<void>
+}
+export declare interface WatchConnectivityApi {
+  send: (message: Record<string, unknown>) => Promise<Record<string, unknown>>
+  updateContext: (context: Record<string, unknown>) => Promise<void>
+  isReachable: () => Promise<boolean>
+  onMessage: (callback: (message: Record<string, unknown>) => void) => () => void
+  onReachabilityChange: (callback: (reachable: boolean) => void) => () => void
+}

package/dist/index.js

@@ -0,0 +1 @@
+import*as p from"craft-native/mobile";var{biometrics:f,camera:A,device:u,haptics:l,lifecycle:v,location:h,notifications:w,permissions:m,secureStorage:d,share:y,appReview:k,deepLinks:n,keepAwake:x,network:L,pushNotifications:R,health:g,liveActivities:C,watchConnectivity:N}=p,b=f,S=A,c=u,o=l,E=v,H=h,P=w,D=m,T=d,M=y,B=k;function r(t){if(typeof t==="string")return t.trim()||null;if(!t||typeof t!=="object")return null;let e=t.url;return typeof e==="string"&&e.trim()?e:null}var K={async getInitialURL(){return r(await n.getInitialURL?.())},onLink(t){return n.onLink?.((e)=>{let i=r(e);if(i)t(i)})??(()=>{})}},U=x,W=L,F=R,I=g,j=C,q=N;function a(){if(typeof globalThis>"u")return;return globalThis}function z(){let t=a();return Boolean(t?.craft)&&c.isMobile()}function G(t){let e=a();if(!e)return()=>{};if(e.craft)return queueMicrotask(()=>t(new Event("craftReady"))),()=>{};let i=(s)=>t(s);return e.addEventListener("craftReady",i,{once:!0}),()=>e.removeEventListener("craftReady",i)}async function J(t){await o.impact("light");try{let e=await t();return await o.notification("success"),e}catch(e){throw await o.notification("error"),e}}var O={biometrics:b,camera:S,device:c,haptics:o,lifecycle:E,location:H,notifications:P,permissions:D,secureStorage:T,share:M,appReview:B,deepLinks:K,keepAwake:U,network:W,pushNotifications:F,health:I,liveActivities:j,watchConnectivity:q,isNativeMobile:z,onReady:G,withFeedback:J};export{J as withNativeFeedback,q as watchConnectivity,M as share,T as secureStorage,F as pushNotifications,D as permissions,G as onMobileReady,P as notifications,r as normalizeDeepLinkURL,W as network,O as mobile,H as location,j as liveActivities,E as lifecycle,U as keepAwake,z as isNativeMobile,I as health,o as haptics,c as device,K as deepLinks,S as camera,b as biometrics,B as appReview};

package/dist/types.d.ts

@@ -0,0 +1,238 @@
+export declare interface DeviceInfo {
+  platform: 'ios' | 'android' | 'macos' | 'windows' | 'linux'
+  osVersion: string
+  model: string
+  manufacturer: string
+  deviceId: string
+  isTablet: boolean
+  screen?: { width: number, height: number, scale: number }
+  battery?: { level: number, isCharging: boolean }
+  network?: { type: 'wifi' | 'cellular' | 'ethernet' | 'none', isConnected: boolean }
+}
+export declare interface DeviceCapabilities {
+  camera: boolean
+  biometrics: boolean
+  nfc: boolean
+  bluetooth: boolean
+  gps: boolean
+  backgroundLocation?: boolean
+  accelerometer: boolean
+  gyroscope: boolean
+  haptics: boolean
+  ar: boolean
+  faceId: boolean
+  touchId: boolean
+}
+export declare interface CameraOptions {
+  camera?: 'front' | 'back'
+  quality?: number
+  maxWidth?: number
+  maxHeight?: number
+  saveToGallery?: boolean
+}
+export declare interface PhotoResult {
+  base64: string
+  uri: string
+  width: number
+  height: number
+  mimeType: string
+}
+export declare interface Location {
+  latitude: number
+  longitude: number
+  altitude?: number
+  accuracy: number
+  heading?: number
+  speed?: number
+  timestamp: number
+}
+export declare interface LocationOptions {
+  enableHighAccuracy?: boolean
+  timeout?: number
+  maximumAge?: number
+}
+export declare interface LocationRecordingState {
+  id: string | null
+  active: boolean
+  paused: boolean
+  startedAt: number | null
+  sampleCount?: number
+}
+export declare interface LocationRecordingResult extends LocationRecordingState {
+  locations: Location[]
+}
+export declare interface ShareOptions {
+  text?: string
+  url?: string
+  title?: string
+  files?: string[]
+}
+export declare interface NotificationOptions {
+  title: string
+  body?: string
+  badge?: number
+  sound?: string
+  data?: Record<string, unknown>
+  scheduleAt?: number
+}
+export declare interface DeviceApi {
+  getInfo: () => Promise<DeviceInfo>
+  getCapabilities: () => Promise<DeviceCapabilities>
+  isMobile: () => boolean
+  isIOS: () => boolean
+  isAndroid: () => boolean
+  getLocale: () => string
+  getTimezone: () => string
+}
+export declare interface HapticsApi {
+  impact: (style?: HapticStyle) => Promise<void>
+  notification: (type?: HapticNotificationType) => Promise<void>
+  selection: () => Promise<void>
+  vibrate: (pattern: number[]) => Promise<void>
+}
+export declare interface PermissionsApi {
+  check: (permission: PermissionType) => Promise<PermissionStatus>
+  request: (permission: PermissionType) => Promise<PermissionStatus>
+  checkMultiple: (permissions: PermissionType[]) => Promise<Record<PermissionType, PermissionStatus>>
+  requestMultiple: (permissions: PermissionType[]) => Promise<Record<PermissionType, PermissionStatus>>
+  openSettings: () => Promise<void>
+}
+export declare interface CameraApi {
+  takePicture: (options?: CameraOptions) => Promise<PhotoResult>
+  pickImage: () => Promise<PhotoResult>
+  pickMultiple: (options?: { maxCount?: number }) => Promise<PhotoResult[]>
+  isAvailable: () => Promise<boolean>
+}
+export declare interface BiometricsApi {
+  isAvailable: () => Promise<boolean>
+  getBiometricType: () => Promise<BiometricType | null>
+  authenticate: (reason: string) => Promise<boolean>
+}
+export declare interface SecureStorageApi {
+  set: (key: string, value: string) => Promise<void>
+  get: (key: string) => Promise<string | null>
+  delete: (key: string) => Promise<void>
+  clear: () => Promise<void>
+}
+export declare interface LocationApi {
+  getCurrentPosition: (options?: LocationOptions) => Promise<Location>
+  watchPosition: (callback: (location: Location) => void, options?: LocationOptions) => number
+  clearWatch: (watchId: number) => void
+  startRecording: (options?: LocationOptions) => Promise<LocationRecordingState>
+  pauseRecording: () => Promise<LocationRecordingState>
+  resumeRecording: () => Promise<LocationRecordingState>
+  stopRecording: () => Promise<LocationRecordingResult>
+  getRecordingState: () => Promise<LocationRecordingState>
+  readRecording: () => Promise<Location[]>
+}
+export declare interface ShareApi {
+  share: (options: ShareOptions) => Promise<void>
+  isAvailable: () => boolean
+}
+export declare interface LifecycleApi {
+  getState: () => AppState
+  onStateChange: (callback: (state: AppState) => void) => () => void
+}
+export declare interface NotificationsApi {
+  show: (options: NotificationOptions) => Promise<void>
+  schedule: (options: NotificationOptions) => Promise<void>
+  cancelAll: () => Promise<void>
+  setBadge: (count: number) => Promise<void>
+}
+export declare interface KeepAwakeApi {
+  enable: () => Promise<void>
+  disable: () => Promise<void>
+}
+export declare interface DeepLinksApi {
+  getInitialURL: () => Promise<string | null>
+  onLink: (callback: (url: string) => void) => () => void
+}
+export declare interface NetworkStatus {
+  type: 'wifi' | 'cellular' | 'ethernet' | 'none' | 'unknown'
+  isConnected: boolean
+}
+export declare interface NetworkApi {
+  getStatus: () => Promise<NetworkStatus>
+  onChange: (callback: (status: NetworkStatus) => void) => () => void
+}
+export declare interface AppReviewApi {
+  request: () => Promise<boolean>
+}
+export declare interface PushNotificationsApi {
+  register: () => Promise<string>
+  onToken: (callback: (token: string) => void) => () => void
+  onNotification: (callback: (data: Record<string, unknown>) => void) => () => void
+}
+export declare interface HealthDataOptions {
+  startDate?: number
+  endDate?: number
+}
+export declare interface HealthDataResult {
+  value: number
+  unit: string
+}
+export declare interface HealthWorkoutLocation {
+  latitude: number
+  longitude: number
+  altitude?: number
+  accuracy?: number
+  timestamp: number
+}
+export declare interface HealthWorkout {
+  activityId: string
+  type: HealthWorkoutType
+  startDate: number
+  endDate: number
+  distanceMeters?: number
+  activeEnergyCalories?: number
+  locations?: HealthWorkoutLocation[]
+}
+export declare interface HealthWorkoutResult {
+  id: string
+}
+export declare interface HealthApi {
+  requestAuthorization: (types: HealthDataType[]) => Promise<boolean>
+  getData: (type: HealthDataType, options?: HealthDataOptions) => Promise<HealthDataResult>
+  saveWorkout: (workout: HealthWorkout) => Promise<HealthWorkoutResult>
+}
+export declare interface LiveActivityState {
+  status?: string
+  distanceMeters?: number
+  durationSeconds?: number
+  progress?: number
+}
+export declare interface LiveActivityOptions extends LiveActivityState {
+  activityId: string
+  title: string
+}
+export declare interface LiveActivitiesApi {
+  start: (options: LiveActivityOptions) => Promise<{ id: string }>
+  update: (state: LiveActivityState) => Promise<void>
+  end: () => Promise<void>
+}
+export declare interface WatchConnectivityApi {
+  send: (message: Record<string, unknown>) => Promise<Record<string, unknown>>
+  updateContext: (context: Record<string, unknown>) => Promise<void>
+  isReachable: () => Promise<boolean>
+  onMessage: (callback: (message: Record<string, unknown>) => void) => () => void
+  onReachabilityChange: (callback: (reachable: boolean) => void) => () => void
+}
+export type HapticStyle = 'light' | 'medium' | 'heavy' | 'soft' | 'rigid';
+export type HapticNotificationType = 'success' | 'warning' | 'error';
+export type PermissionType = | 'camera'
+  | 'microphone'
+  | 'photos'
+  | 'location'
+  | 'locationAlways'
+  | 'notifications'
+  | 'contacts'
+  | 'calendar'
+  | 'reminders'
+  | 'bluetooth'
+  | 'motion'
+  | 'health';
+export type PermissionStatus = 'granted' | 'denied' | 'undetermined' | 'restricted';
+export type BiometricType = 'faceId' | 'touchId' | 'fingerprint' | 'face' | 'iris';
+export type AppState = 'active' | 'inactive' | 'background';
+export type HealthDataType = 'steps' | 'heartRate' | 'activeEnergy' | 'distance' | 'workouts';
+export type HealthWorkoutType = 'running' | 'walking' | 'hiking' | 'cycling';

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@stacksjs/mobile",
+  "type": "module",
+  "sideEffects": false,
+  "version": "0.70.375",
+  "description": "Craft-powered native mobile runtime for Stacks and STX applications",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/mobile#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./storage/framework/core/mobile"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
+    "test": "bun test"
+  },
+  "devDependencies": {
+    "@stacksjs/build": "0.70.375",
+    "better-dx": "^0.2.17",
+    "craft-native": ">=0.0.55"
+  },
+  "peerDependencies": {
+    "craft-native": ">=0.0.65"
+  },
+  "peerDependenciesMeta": {
+    "craft-native": {
+      "optional": true
+    }
+  }
+}