desktopr 2.0.1 → 2.0.3

package/dist-sdk/_constants.d.ts

@@ -1,5 +1,5 @@
 export declare const APP_URL: string;
-export declare const APP_VERSION: string;
+export declare const API_VERSION: string;
 export declare const COMAPNION_WINDOW_LABEL_PREFIX: string;
 export declare const READY_EVENT_NAME: string;
 export declare const WINDOWS_LABELS_TRACKER_VARIABLE_NAME: string;

package/dist-sdk/_constants.js

@@ -3,10 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_STORAGE_NAMESPACE = exports.WINDOWS_LABELS_TRACKER_VARIABLE_NAME = exports.READY_EVENT_NAME = exports.COMAPNION_WINDOW_LABEL_PREFIX = exports.APP_VERSION = exports.APP_URL = void 0;
+exports.BROWSER_STORAGE_NAMESPACE = exports.WINDOWS_LABELS_TRACKER_VARIABLE_NAME = exports.READY_EVENT_NAME = exports.COMAPNION_WINDOW_LABEL_PREFIX = exports.API_VERSION = exports.APP_URL = void 0;
 const bridge_constants_json_1 = __importDefault(require("./bridge.constants.json"));
 exports.APP_URL = bridge_constants_json_1.default.appUrl;
-exports.APP_VERSION = bridge_constants_json_1.default.appVersion;
+exports.API_VERSION = bridge_constants_json_1.default.apiVersion;
 exports.COMAPNION_WINDOW_LABEL_PREFIX = bridge_constants_json_1.default.companionWindowLabelPrefix;
 exports.READY_EVENT_NAME = "dtrReady";
 exports.WINDOWS_LABELS_TRACKER_VARIABLE_NAME = "open-windows-labels-tracker-rpkw6kjzxn8bfhj5u74q";

package/dist-sdk/_main.d.ts

@@ -0,0 +1,20 @@
+export * from "./core/_main";
+export * from "./desktopr/_main";
+export * from "./modules/rs/files/_main";
+export * from "./modules/rs/events/_main";
+export * from "./modules/rs/fs/_main";
+export * from "./modules/rs/clipboard/_main";
+export * from "./modules/rs/shortcuts/_main";
+export * from "./modules/rs/notifications/_main";
+export * from "./modules/rs/app/_main";
+export * from "./modules/rs/window/_main";
+export * from "./modules/rs/dragdrop/_main";
+export * from "./modules/rs/menu/_main";
+export * from "./modules/rs/diagnostics/_main";
+export * from "./modules/rs/network/_main";
+export * from "./modules/rs/autostart/_main";
+export * from "./modules/rs/badge/_main";
+export * from "./modules/rs/worker/_main";
+export * from "./modules/rs/contextMenu/_main";
+export * from "./modules/rs/companion/_main";
+export * from "./modules/rs/globalVariables/_main";

package/dist-sdk/_main.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core/_main"), exports);
+__exportStar(require("./desktopr/_main"), exports);
+__exportStar(require("./modules/rs/files/_main"), exports);
+__exportStar(require("./modules/rs/events/_main"), exports);
+__exportStar(require("./modules/rs/fs/_main"), exports);
+__exportStar(require("./modules/rs/clipboard/_main"), exports);
+__exportStar(require("./modules/rs/shortcuts/_main"), exports);
+__exportStar(require("./modules/rs/notifications/_main"), exports);
+__exportStar(require("./modules/rs/app/_main"), exports);
+__exportStar(require("./modules/rs/window/_main"), exports);
+__exportStar(require("./modules/rs/dragdrop/_main"), exports);
+__exportStar(require("./modules/rs/menu/_main"), exports);
+__exportStar(require("./modules/rs/diagnostics/_main"), exports);
+__exportStar(require("./modules/rs/network/_main"), exports);
+__exportStar(require("./modules/rs/autostart/_main"), exports);
+__exportStar(require("./modules/rs/badge/_main"), exports);
+__exportStar(require("./modules/rs/worker/_main"), exports);
+__exportStar(require("./modules/rs/contextMenu/_main"), exports);
+__exportStar(require("./modules/rs/companion/_main"), exports);
+__exportStar(require("./modules/rs/globalVariables/_main"), exports);

package/dist-sdk/bridge.constants.json

@@ -1,5 +1,5 @@
 {
     "appUrl": "http://blank.html",
-    "appVersion": "0.2.1",
+    "apiVersion": "2.0.3",
     "companionWindowLabelPrefix": "dtr-cache-only-window-"
 }

package/dist-sdk/core/_main.d.ts

@@ -0,0 +1,4 @@
+export declare function buildCore(): {
+    readonly ready: Promise<true>;
+    invoke<T = unknown>(cmd: string, payload?: Record<string, unknown>): Promise<T>;
+};

package/dist-sdk/core/_main.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCore = buildCore;
+const _helpers_1 = require("../_helpers");
+function buildCore() {
+    return {
+        get ready() {
+            return (0, _helpers_1.ensureCore)().then(() => true);
+        },
+        async invoke(cmd, payload) {
+            const core = await (0, _helpers_1.ensureCore)();
+            return core.invoke(cmd, payload);
+        },
+    };
+}

package/dist-sdk/desktopr/_helpers.d.ts

@@ -4,3 +4,4 @@ export declare const normalizeString: (str: string, options?: {
     spacesFiller: string;
 }) => string;
 export declare const platformSpecifcFilter: (platforms: DtrPlatform[]) => Promise<void>;
+export declare const getAppVersion: () => Promise<string>;

package/dist-sdk/desktopr/_helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.platformSpecifcFilter = exports.normalizeString = void 0;
+exports.getAppVersion = exports.platformSpecifcFilter = exports.normalizeString = void 0;
 const utils_1 = require("../utils");
 const normalizeString = (str, options = {
     toLowerCase: true,
@@ -20,11 +20,20 @@ const normalizeString = (str, options = {
 };
 exports.normalizeString = normalizeString;
 const platformSpecifcFilter = async (platforms) => {
-    const appInfo = await window.Desktopr?.app.info();
+    const appInfo = (await window.Desktopr?.app.info());
     if (!appInfo)
         throw "Failed to check platform";
     const plat = appInfo.os;
-    if (!(platforms.includes(plat)))
+    if (!platforms.includes(plat))
         throw `[unsupported platform] this method is not supported on ${plat}`;
 };
 exports.platformSpecifcFilter = platformSpecifcFilter;
+const getAppVersion = async () => {
+    const desktopr = window?.Desktopr;
+    if (!desktopr)
+        throw "[getAppVersion] Desktopr is not available";
+    const appInfo = await desktopr.app.info();
+    const version = appInfo.version;
+    return version ?? "";
+};
+exports.getAppVersion = getAppVersion;

package/dist-sdk/desktopr/_main.d.ts

@@ -0,0 +1,4 @@
+import { DesktoprInstanceInterface } from "../_types";
+export declare const DesktoprInstance: DesktoprInstanceInterface;
+export declare const dtrInitiators: () => Promise<void>;
+export declare const dtrReadyEventListener: (callback: Function) => void;

package/dist-sdk/desktopr/_main.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dtrReadyEventListener = exports.dtrInitiators = exports.DesktoprInstance = void 0;
+// import { listenForEvent } from "../_helpers";
+const _constants_1 = require("../_constants");
+exports.DesktoprInstance = {
+    ready: () => {
+        if (!window?.Desktopr)
+            return false;
+        return true;
+    },
+    get: () => {
+        if (!exports.DesktoprInstance.ready())
+            throw ("'window.Desktopr' not found");
+        return window?.Desktopr;
+    }
+};
+const dtrInitiators = async () => {
+    try {
+        if (!exports.DesktoprInstance.ready())
+            throw ("Desktopr instance not found");
+        console.log("## READY ##");
+        const eventReady = new CustomEvent(_constants_1.READY_EVENT_NAME);
+        window?.dispatchEvent(eventReady);
+    }
+    catch (error) {
+        console.error(error);
+    }
+};
+exports.dtrInitiators = dtrInitiators;
+const dtrReadyEventListener = (callback) => window.addEventListener(_constants_1.READY_EVENT_NAME, () => callback());
+exports.dtrReadyEventListener = dtrReadyEventListener;

package/dist-sdk/desktopr/_types.d.ts

@@ -29,7 +29,7 @@ export type DtrPlatform = "macos" | "linux" | "windows";
  */
 export type DesktoprAPI = {
     readonly isAvailable: boolean;
-    readonly version: string;
+    readonly apiVersion: string;
     readonly ready: Promise<true>;
     invoke<T = unknown>(cmd: string, payload?: Record<string, unknown>): Promise<T>;
     isDesktop: boolean;

package/dist-sdk/modules/rs/diagnostics/_helpers.d.ts

@@ -1,8 +1,9 @@
 import { DesktoprAPI } from "../../../_types";
-import { DiagnosticsTestFunctions, PrivacySettings } from "./_types";
+import { DiagnosticsTestFunctions, PrivacySettings, PrivacySettingsCamelCase } from "./_types";
 export declare const diagnosticsSettings: (core: {
     invoke: DesktoprAPI["invoke"];
-}, settings?: PrivacySettings) => Promise<unknown>;
+}, settings?: PrivacySettings) => Promise<PrivacySettingsCamelCase>;
+export declare const deriveAppVersion: (v?: string) => Promise<string>;
 export declare function buildDiagnosticsTestFunctions(core: {
     invoke: DesktoprAPI["invoke"];
 }): DiagnosticsTestFunctions;

package/dist-sdk/modules/rs/diagnostics/_helpers.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diagnosticsSettings = void 0;
+exports.deriveAppVersion = exports.diagnosticsSettings = void 0;
 exports.buildDiagnosticsTestFunctions = buildDiagnosticsTestFunctions;
 const utils_1 = require("../../../utils");
+const _helpers_1 = require("../../../_helpers");
 const diagnosticsSettings = async (core, settings) => {
     if (settings?.retentionDaysAnalytics && !utils_1.Num.isU32(settings.retentionDaysAnalytics))
         throw ("[retentionDaysAnalytics] the value must be a U32 integer number");
@@ -21,6 +22,13 @@ const diagnosticsSettings = async (core, settings) => {
     });
 };
 exports.diagnosticsSettings = diagnosticsSettings;
+const deriveAppVersion = async (v) => {
+    if (v)
+        return v;
+    const version = await (0, _helpers_1.getAppVersion)();
+    return version;
+};
+exports.deriveAppVersion = deriveAppVersion;
 // ==============================
 // Test functions
 // ==============================

package/dist-sdk/modules/rs/diagnostics/_main.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildDiagnostics = buildDiagnostics;
 const _helpers_1 = require("./_helpers");
-const _constants_1 = require("../../../_constants");
 function buildDiagnostics(core) {
     return {
         settings: {
@@ -11,19 +10,31 @@ function buildDiagnostics(core) {
             get: () => core.invoke("dtr_logs_get_privacy", {}),
         },
         // SOLO analytics (Rust vuole AnalyticsRecord), usa key record_type
-        newRecord: (recordType, payload, env) => core.invoke("dtr_logs_new_record", {
-            recordType,
-            payload,
-            env,
-            appVersion: _constants_1.APP_VERSION,
-        }),
+        newRecord: async (recordType, payload, env, appVersion) => {
+            const v = await (0, _helpers_1.deriveAppVersion)(appVersion);
+            return await core.invoke("dtr_logs_new_record", {
+                recordType,
+                payload,
+                env,
+                appVersion: v
+            });
+        },
         newError: {
-            js: (payload) => core.invoke("dtr_logs_record_js_error", { payload, appVersion: _constants_1.APP_VERSION }),
-            native: (payload) => core.invoke("dtr_logs_record_native_error", { payload, appVersion: _constants_1.APP_VERSION }),
+            js: async (payload, appVersion) => {
+                const v = await (0, _helpers_1.deriveAppVersion)(appVersion);
+                return await core.invoke("dtr_logs_record_js_error", { payload, appVersion: v });
+            },
+            native: async (payload, appVersion) => {
+                const v = await (0, _helpers_1.deriveAppVersion)(appVersion);
+                return await core.invoke("dtr_logs_record_native_error", { payload, appVersion: v });
+            },
             // Rust richiede 'env' obbligatorio: di default "generic" se non passato
-            generic: (payload, env = "generic") => core.invoke("dtr_logs_record_error", { payload, appVersion: _constants_1.APP_VERSION, env }),
+            generic: async (payload, env = "generic", appVersion) => {
+                const v = await (0, _helpers_1.deriveAppVersion)(appVersion);
+                return await core.invoke("dtr_logs_record_error", { payload, env, appVersion: v });
+            },
         },
-        readRecordsFile: (relPath, maxBytes) => core.invoke("dtr_logs_read_file", { relPath, maxBytes }),
+        readRecordsFile: (relPath) => core.invoke("dtr_logs_read_file", { relPath }),
         // qui avevi chiamato dtr_logs_read_file: correggo su dtr_logs_list_files
         listRecordsFiles: (area) => core.invoke("dtr_logs_list_files", { area }),
         runRetention: () => core.invoke("dtr_logs_run_retention", {}),

package/dist-sdk/modules/rs/diagnostics/_types.d.ts

@@ -1,33 +1,34 @@
-import { U32 } from "../../../utils";
+import { U32, U64 } from "../../../utils";
 export interface DiagnosticsInterface {
     settings: {
-        set: (settings?: PrivacySettings) => Promise<unknown>;
-        get: () => Promise<unknown>;
+        set: (settings?: PrivacySettings) => Promise<PrivacySettingsCamelCase>;
+        get: () => Promise<PrivacySettingsCamelCase>;
     };
-    newRecord: (recordType: string, payload: AnalyticsPayload, env: "js" | "native" | string) => Promise<unknown>;
+    newRecord: (recordType: string, payload: AnalyticsPayload, env: "js" | "native" | string, appVersion?: string) => Promise<void>;
     newError: {
-        js: (payload: ErrorPayload) => Promise<unknown>;
-        native: (payload: ErrorPayload) => Promise<unknown>;
-        generic: (payload: ErrorPayload, env?: string) => Promise<unknown>;
+        js: (payload: ErrorPayload, appVersion?: string) => Promise<void>;
+        native: (payload: ErrorPayload, appVersion?: string) => Promise<void>;
+        generic: (payload: ErrorPayload, env?: string, appVersion?: string) => Promise<void>;
     };
-    readRecordsFile: (relPath: string, maxBytes?: number) => Promise<Uint8Array<ArrayBufferLike>>;
-    listRecordsFiles: (area: "logs" | "crashes") => Promise<unknown>;
-    runRetention: () => Promise<unknown>;
-    export: (targetZipPath: string) => Promise<unknown>;
+    readRecordsFile: (relPath: string) => Promise<string>;
+    listRecordsFiles: (area: DiagnosticsArea) => Promise<ListedFile[]>;
+    runRetention: () => Promise<void>;
+    export: (targetZipPath: string) => Promise<void>;
     test: DiagnosticsTestFunctions;
 }
+export type DiagnosticsArea = "logs" | "crashes" | "runtime";
 export type DiagnosticsTestFunctions = {
     testGenerateRecords: (n?: number) => Promise<void>;
     testThrowJsError: () => Promise<never>;
     testPanicRust: () => Promise<void>;
     testExportZip: (path: string) => Promise<void>;
-    testForceRetention: (area: "logs" | "analytics" | "crashes") => Promise<void>;
+    testForceRetention: (area: DiagnosticsArea) => Promise<void>;
 };
 export type ErrorPayload = {
     message: string;
     filename?: string;
-    lineno?: number;
-    colno?: number;
+    lineno?: U32;
+    colno?: U32;
     stack?: string;
 };
 export type AnalyticsPayload = {
@@ -35,9 +36,9 @@ export type AnalyticsPayload = {
     props?: Record<string, unknown>;
 };
 export type ListedFile = {
-    relPath: string;
-    bytes: number;
-    modified_ms: number;
+    rel_path: string;
+    bytes: U64;
+    modified_ms: U64;
 };
 export type RecordPayload = ErrorPayload | AnalyticsPayload;
 export type PrivacySettings = {
@@ -47,3 +48,10 @@ export type PrivacySettings = {
     retentionDaysLogs?: U32;
     retentionDaysCrashes?: U32;
 };
+export type PrivacySettingsCamelCase = {
+    analytics_enabled?: boolean;
+    crash_reports_enabled?: boolean;
+    retention_days_analytics?: U32;
+    retention_days_logs?: U32;
+    retention_days_crashes?: U32;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "desktopr",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Official JS/TS SDK for the Desktopr native bridge",
   "main": "dist-sdk/sdk/index.js",
   "types": "dist-sdk/sdk/index.d.ts",
@@ -11,8 +11,9 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rm -rf dist-sdk && tsc -p ../tsconfig.sdk.json",
+    "syncVersion": "bash ../scripts/sync-api-version.sh",
+    "build": "rm -rf dist-sdk && npm run syncVersion && tsc -p ../tsconfig.sdk.json",
     "pub": "npm publish --access public",
     "prepublishOnly": "npm run build"
   }
-}
+}