@photon-os/sdk 0.5.1 → 1.0.0-alpha.0

package/dist/index.d.mts

@@ -0,0 +1,125 @@
+type AppBundleId = string;
+type AppDefinition = {
+    bundleId: AppBundleId;
+    name: string;
+    author: string;
+    url: string;
+};
+type RunningAppInstance = {
+    definition: AppDefinition;
+    startedAt: Date;
+    lastForegroundedAt: Date;
+    isInBackground: boolean;
+};
+
+/**
+ * Value types supported for preferences.
+ * Stored as JSONB in the database.
+ */
+type PreferenceValue = string | number | boolean | null | PreferenceValue[] | {
+    [key: string]: PreferenceValue;
+};
+
+/**
+ * Represents the authenticated user visible to apps via the SDK.
+ * This is a read-only, minimal representation.
+ */
+type PhotonUser = {
+    /** Unique user identifier */
+    id: string;
+    /** User's display name */
+    displayName: string;
+};
+
+type AppLaunchResult = {
+    launched: boolean;
+    error: Error | null;
+    app: AppDefinition;
+};
+type OperatingSystemAPI = {
+    system_homeButton: () => Promise<void>;
+    apps_getInstalledApps: () => Promise<AppDefinition[]>;
+    apps_launchApp: (app: AppDefinition) => Promise<AppLaunchResult>;
+    apps_foregroundApp: (app: AppDefinition) => Promise<void>;
+    apps_requestAppInstall: (app: AppDefinition) => Promise<void>;
+    apps_requestAppUninstall: (app: AppDefinition) => Promise<void>;
+    user_getCurrentUser: () => Promise<PhotonUser>;
+    prefs_getSandboxed: (key: string) => Promise<PreferenceValue>;
+    prefs_setSandboxed: (key: string, value: PreferenceValue) => Promise<void>;
+    prefs_deleteSandboxed: (key: string) => Promise<void>;
+    prefs_getShared: (key: string) => Promise<PreferenceValue>;
+    prefs_setShared: (key: string, value: PreferenceValue) => Promise<void>;
+    prefs_deleteShared: (key: string) => Promise<void>;
+};
+
+declare class AppManager {
+    private os;
+    constructor(os: OS);
+    getInstalledApps(): Promise<AppDefinition[]>;
+    launchApp(app: AppDefinition): Promise<AppLaunchResult>;
+    requestAppInstall(app: AppDefinition): Promise<void>;
+    requestAppUninstall(app: AppDefinition): Promise<void>;
+}
+
+/**
+ * Manages user preferences for apps.
+ *
+ * Sandboxed methods (get, set, delete) store preferences scoped to the calling app.
+ * Shared methods (getShared, setShared, deleteShared) store preferences accessible by all apps.
+ */
+declare class PreferencesManager {
+    private os;
+    constructor(os: OS);
+    /**
+     * Get a sandboxed preference value (app-specific).
+     * Only accessible by the app that set it.
+     */
+    get(key: string): Promise<PreferenceValue>;
+    /**
+     * Set a sandboxed preference value (app-specific).
+     * Only accessible by the app that set it.
+     */
+    set(key: string, value: PreferenceValue): Promise<void>;
+    /**
+     * Delete a sandboxed preference (app-specific).
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Get a shared preference value.
+     * Accessible by all apps.
+     */
+    getShared(key: string): Promise<PreferenceValue>;
+    /**
+     * Set a shared preference value.
+     * Accessible by all apps.
+     */
+    setShared(key: string, value: PreferenceValue): Promise<void>;
+    /**
+     * Delete a shared preference.
+     */
+    deleteShared(key: string): Promise<void>;
+}
+
+declare class UserManager {
+    private os;
+    constructor(os: OS);
+    /** Get the current authenticated user */
+    getCurrentUser(): Promise<PhotonUser>;
+}
+
+type OSConfig = {
+    target: Window;
+};
+declare class OS {
+    apps: AppManager;
+    prefs: PreferencesManager;
+    user: UserManager;
+    private config;
+    constructor(config?: OSConfig);
+    homeButton(): Promise<void>;
+    getRPCAPI(): Promise<OperatingSystemAPI>;
+}
+
+declare const VERSION = "1.0.0";
+
+export { type AppBundleId, type AppDefinition, type AppLaunchResult, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, VERSION };

package/dist/index.d.ts

@@ -0,0 +1,125 @@
+type AppBundleId = string;
+type AppDefinition = {
+    bundleId: AppBundleId;
+    name: string;
+    author: string;
+    url: string;
+};
+type RunningAppInstance = {
+    definition: AppDefinition;
+    startedAt: Date;
+    lastForegroundedAt: Date;
+    isInBackground: boolean;
+};
+
+/**
+ * Value types supported for preferences.
+ * Stored as JSONB in the database.
+ */
+type PreferenceValue = string | number | boolean | null | PreferenceValue[] | {
+    [key: string]: PreferenceValue;
+};
+
+/**
+ * Represents the authenticated user visible to apps via the SDK.
+ * This is a read-only, minimal representation.
+ */
+type PhotonUser = {
+    /** Unique user identifier */
+    id: string;
+    /** User's display name */
+    displayName: string;
+};
+
+type AppLaunchResult = {
+    launched: boolean;
+    error: Error | null;
+    app: AppDefinition;
+};
+type OperatingSystemAPI = {
+    system_homeButton: () => Promise<void>;
+    apps_getInstalledApps: () => Promise<AppDefinition[]>;
+    apps_launchApp: (app: AppDefinition) => Promise<AppLaunchResult>;
+    apps_foregroundApp: (app: AppDefinition) => Promise<void>;
+    apps_requestAppInstall: (app: AppDefinition) => Promise<void>;
+    apps_requestAppUninstall: (app: AppDefinition) => Promise<void>;
+    user_getCurrentUser: () => Promise<PhotonUser>;
+    prefs_getSandboxed: (key: string) => Promise<PreferenceValue>;
+    prefs_setSandboxed: (key: string, value: PreferenceValue) => Promise<void>;
+    prefs_deleteSandboxed: (key: string) => Promise<void>;
+    prefs_getShared: (key: string) => Promise<PreferenceValue>;
+    prefs_setShared: (key: string, value: PreferenceValue) => Promise<void>;
+    prefs_deleteShared: (key: string) => Promise<void>;
+};
+
+declare class AppManager {
+    private os;
+    constructor(os: OS);
+    getInstalledApps(): Promise<AppDefinition[]>;
+    launchApp(app: AppDefinition): Promise<AppLaunchResult>;
+    requestAppInstall(app: AppDefinition): Promise<void>;
+    requestAppUninstall(app: AppDefinition): Promise<void>;
+}
+
+/**
+ * Manages user preferences for apps.
+ *
+ * Sandboxed methods (get, set, delete) store preferences scoped to the calling app.
+ * Shared methods (getShared, setShared, deleteShared) store preferences accessible by all apps.
+ */
+declare class PreferencesManager {
+    private os;
+    constructor(os: OS);
+    /**
+     * Get a sandboxed preference value (app-specific).
+     * Only accessible by the app that set it.
+     */
+    get(key: string): Promise<PreferenceValue>;
+    /**
+     * Set a sandboxed preference value (app-specific).
+     * Only accessible by the app that set it.
+     */
+    set(key: string, value: PreferenceValue): Promise<void>;
+    /**
+     * Delete a sandboxed preference (app-specific).
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Get a shared preference value.
+     * Accessible by all apps.
+     */
+    getShared(key: string): Promise<PreferenceValue>;
+    /**
+     * Set a shared preference value.
+     * Accessible by all apps.
+     */
+    setShared(key: string, value: PreferenceValue): Promise<void>;
+    /**
+     * Delete a shared preference.
+     */
+    deleteShared(key: string): Promise<void>;
+}
+
+declare class UserManager {
+    private os;
+    constructor(os: OS);
+    /** Get the current authenticated user */
+    getCurrentUser(): Promise<PhotonUser>;
+}
+
+type OSConfig = {
+    target: Window;
+};
+declare class OS {
+    apps: AppManager;
+    prefs: PreferencesManager;
+    user: UserManager;
+    private config;
+    constructor(config?: OSConfig);
+    homeButton(): Promise<void>;
+    getRPCAPI(): Promise<OperatingSystemAPI>;
+}
+
+declare const VERSION = "1.0.0";
+
+export { type AppBundleId, type AppDefinition, type AppLaunchResult, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, VERSION };