orgnote-api 0.42.1 → 0.42.3

package/api.d.ts

@@ -1,4 +1,4 @@
-import { InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, SyncStoreDefinition, BufferViewerStoreDefinition, CommandsStoreDefinition, CommandsGroupStoreDefinition, ModalStoreDefinition, SettingsStoreDefinition, SettingsUiStoreDefinition, MultipleUploadParams, UploadParams, CompletionStoreDefinition, PaneStoreDefinition, LayoutStoreDefinition, FileManagerStoreDefinition, UseScreenDetection, UseKeyboardState, NotificationsStoreDefinition, BufferStoreDefinition, BufferProviderStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition, FontStoreDefinition, EmbeddedBufferStoreDefinition, UseFileContent, UseAppResume } from './models/index.js';
+import { InlineEmbeddedWidget, MultilineEmbeddedWidget, OrgLineClass, SyncStoreDefinition, BufferViewerStoreDefinition, CommandsStoreDefinition, CommandsGroupStoreDefinition, ModalStoreDefinition, SettingsStoreDefinition, SettingsUiStoreDefinition, MultipleUploadParams, UploadParams, CompletionStoreDefinition, PaneStoreDefinition, LayoutStoreDefinition, FileManagerStoreDefinition, UseScreenDetection, UseKeyboardState, NotificationsStoreDefinition, BufferStoreDefinition, BufferProviderStoreDefinition, Repositories, LogStoreDefinition, UseSystemInfo, ContextMenuStoreDefinition, QueueStoreDefinition, FileGuardStoreDefinition, FileWatcherStoreDefinition, BuildOrgNoteUrl, AuthStoreDefinition, FileSearchStoreDefinition, FileMetaStoreDefinition, FontStoreDefinition, EmbeddedBufferStoreDefinition, UseFileContent, UseAppResume, ClientUpdateStoreDefinition } from './models/index.js';
 import { WebSocketClient } from './websocket/client.js';
 import { WidgetType } from './models/widget-type.js';
 import { NodeType } from 'org-mode-ast';
@@ -163,6 +163,7 @@ export interface OrgNoteApi {
          * Also handles API token lifecycle (create, list, revoke).
          */
         useSettings: SettingsStoreDefinition;
+        useClientUpdate: ClientUpdateStoreDefinition;
         useConfig: ConfigStoreDefinition;
         /**
          * Access the [Quasar](https://quasar.dev/) framework globals ($q).

package/constants/i18n-keys.d.ts

@@ -189,6 +189,12 @@ export declare enum i18n {
     GPG_EMAIL_INVALID = "gpg email invalid",
     CLEAR_ALL_NOTIFICATIONS = "clear all notifications",
     NO_NOTIFICATIONS = "no notifications",
+    SHOW_LATEST_CHANGES = "show latest changes",
+    LATEST_CHANGES_NOTIFICATION_DESCRIPTION = "open latest changes notification description",
+    NO_LATEST_CHANGES = "no latest changes",
+    UPDATED_TO_VERSION = "updated to version",
+    UPDATED_FROM_VERSION = "updated from version",
+    OPEN_RELEASE_NOTES = "open release notes",
     GRAPH_TITLE = "graph.title",
     GRAPH_DESCRIPTION = "graph.description",
     GRAPH_EMPTY_TITLE = "graph.empty.title",
@@ -231,7 +237,9 @@ export declare enum i18n {
 export declare const I18N: {
     REPORT_BUG: DefaultCommands.REPORT_BUG;
     OPEN_SYSTEM_INFO: DefaultCommands.OPEN_SYSTEM_INFO;
+    SHOW_LATEST_CHANGES: DefaultCommands.SHOW_LATEST_CHANGES;
     SHOW_LOGS: DefaultCommands.SHOW_LOGS;
+    APPLY_PWA_UPDATE: DefaultCommands.APPLY_PWA_UPDATE;
     CLEAR_LOGS: DefaultCommands.CLEAR_LOGS;
     TOGGLE_SIDEBAR: DefaultCommands.TOGGLE_SIDEBAR;
     CLOSE_SIDEBAR: DefaultCommands.CLOSE_SIDEBAR;
@@ -552,6 +560,11 @@ export declare const I18N: {
     GPG_EMAIL_INVALID: i18n.GPG_EMAIL_INVALID;
     CLEAR_ALL_NOTIFICATIONS: i18n.CLEAR_ALL_NOTIFICATIONS;
     NO_NOTIFICATIONS: i18n.NO_NOTIFICATIONS;
+    LATEST_CHANGES_NOTIFICATION_DESCRIPTION: i18n.LATEST_CHANGES_NOTIFICATION_DESCRIPTION;
+    NO_LATEST_CHANGES: i18n.NO_LATEST_CHANGES;
+    UPDATED_TO_VERSION: i18n.UPDATED_TO_VERSION;
+    UPDATED_FROM_VERSION: i18n.UPDATED_FROM_VERSION;
+    OPEN_RELEASE_NOTES: i18n.OPEN_RELEASE_NOTES;
     GRAPH_TITLE: i18n.GRAPH_TITLE;
     GRAPH_DESCRIPTION: i18n.GRAPH_DESCRIPTION;
     GRAPH_EMPTY_TITLE: i18n.GRAPH_EMPTY_TITLE;

package/constants/i18n-keys.js

@@ -200,6 +200,12 @@ export var i18n;
     i18n["GPG_EMAIL_INVALID"] = "gpg email invalid";
     i18n["CLEAR_ALL_NOTIFICATIONS"] = "clear all notifications";
     i18n["NO_NOTIFICATIONS"] = "no notifications";
+    i18n["SHOW_LATEST_CHANGES"] = "show latest changes";
+    i18n["LATEST_CHANGES_NOTIFICATION_DESCRIPTION"] = "open latest changes notification description";
+    i18n["NO_LATEST_CHANGES"] = "no latest changes";
+    i18n["UPDATED_TO_VERSION"] = "updated to version";
+    i18n["UPDATED_FROM_VERSION"] = "updated from version";
+    i18n["OPEN_RELEASE_NOTES"] = "open release notes";
     // Graph
     i18n["GRAPH_TITLE"] = "graph.title";
     i18n["GRAPH_DESCRIPTION"] = "graph.description";

package/models/client-update-store.d.ts

@@ -0,0 +1,11 @@
+import type { ComputedRef } from 'vue';
+import type { StoreDefinition } from './store.js';
+import type { ChangelogRecord } from './client-update.js';
+export interface ClientUpdateStore {
+    updateChangelog: ComputedRef<ChangelogRecord | null>;
+    unreadUpdateChangelog: ComputedRef<ChangelogRecord | null>;
+    syncUpdateChangelog: () => Promise<void>;
+    loadLatestChangelog: () => Promise<ChangelogRecord | null>;
+    markChangelogAsRead: () => void;
+}
+export type ClientUpdateStoreDefinition = StoreDefinition<ClientUpdateStore>;

package/models/client-update-store.js

@@ -0,0 +1 @@
+export {};

package/models/client-update.d.ts

@@ -0,0 +1,10 @@
+export interface Changelog {
+    version: string;
+    changeLog: string;
+    url: string;
+}
+export interface ChangelogRecord extends Changelog {
+    fromVersion?: string;
+    detectedAt: string;
+    viewedAt?: string;
+}

package/models/client-update.js

@@ -0,0 +1 @@
+export {};

package/models/default-commands.d.ts

@@ -1,7 +1,9 @@
 export declare enum DefaultCommands {
     REPORT_BUG = "report bug",
     OPEN_SYSTEM_INFO = "open system info",
+    SHOW_LATEST_CHANGES = "show latest changes",
     SHOW_LOGS = "show logs",
+    APPLY_PWA_UPDATE = "apply pwa update",
     CLEAR_LOGS = "clear logs",
     TOGGLE_SIDEBAR = "toggle sidebar",
     CLOSE_SIDEBAR = "close sidebar",

package/models/default-commands.js

@@ -8,7 +8,9 @@ export var DefaultCommands;
     // Global commands
     DefaultCommands["REPORT_BUG"] = "report bug";
     DefaultCommands["OPEN_SYSTEM_INFO"] = "open system info";
+    DefaultCommands["SHOW_LATEST_CHANGES"] = "show latest changes";
     DefaultCommands["SHOW_LOGS"] = "show logs";
+    DefaultCommands["APPLY_PWA_UPDATE"] = "apply pwa update";
     DefaultCommands["CLEAR_LOGS"] = "clear logs";
     DefaultCommands["TOGGLE_SIDEBAR"] = "toggle sidebar";
     DefaultCommands["CLOSE_SIDEBAR"] = "close sidebar";

package/models/index.d.ts

@@ -19,6 +19,7 @@ export * from './user.js';
 export * from './oauth-provider.js';
 export * from './auth-state.js';
 export * from './orgnote-config.js';
+export * from './client-update.js';
 export * from './sync-profile-config.js';
 export * from './platform-specific.js';
 export * from './css-utils.js';
@@ -60,6 +61,7 @@ export * from './extension-store.js';
 export * from './file-system-store.js';
 export * from './file-watcher-store.js';
 export * from './settings-store.js';
+export * from './client-update-store.js';
 export * from './encryption-store.js';
 export * from './ui-store.js';
 export * from './sidebar-store.js';

package/models/index.js

@@ -19,6 +19,7 @@ export * from "./user.js";
 export * from "./oauth-provider.js";
 export * from "./auth-state.js";
 export * from "./orgnote-config.js";
+export * from "./client-update.js";
 export * from "./sync-profile-config.js";
 export * from "./platform-specific.js";
 export * from "./css-utils.js";
@@ -62,6 +63,7 @@ export * from "./extension-store.js";
 export * from "./file-system-store.js";
 export * from "./file-watcher-store.js";
 export * from "./settings-store.js";
+export * from "./client-update-store.js";
 export * from "./encryption-store.js";
 export * from "./ui-store.js";
 export * from "./sidebar-store.js";

package/models/notification-config.d.ts

@@ -1,5 +1,5 @@
 import { StyleVariant } from './style-variant.js';
-export interface NotificationConfig {
+export interface NotificationConfig<T = unknown> {
     id?: string;
     message: string;
     description?: string;
@@ -11,5 +11,7 @@ export interface NotificationConfig {
     icon?: string;
     iconEnabled?: boolean;
     onClick?: () => void;
+    actionCommand?: string;
+    actionPayload?: T;
     stored?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.42.1",
+  "version": "0.42.3",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",

package/remote-api/api.d.ts

@@ -1120,6 +1120,13 @@ export declare class SyncApi extends BaseAPI {
  * @export
  */
 export declare const SystemInfoApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GetLatestClientUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    systemInfoClientUpdateLatestGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary GetUpdatesFromVersion
@@ -1142,6 +1149,13 @@ export declare const SystemInfoApiAxiosParamCreator: (configuration?: Configurat
  * @export
  */
 export declare const SystemInfoApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GetLatestClientUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    systemInfoClientUpdateLatestGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelsOrgNoteClientUpdateInfo>>;
     /**
      *
      * @summary GetUpdatesFromVersion
@@ -1164,6 +1178,13 @@ export declare const SystemInfoApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const SystemInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary GetLatestClientUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    systemInfoClientUpdateLatestGet(options?: any): AxiosPromise<ModelsOrgNoteClientUpdateInfo>;
     /**
      *
      * @summary GetUpdatesFromVersion
@@ -1188,6 +1209,14 @@ export declare const SystemInfoApiFactory: (configuration?: Configuration, baseP
  * @extends {BaseAPI}
  */
 export declare class SystemInfoApi extends BaseAPI {
+    /**
+     *
+     * @summary GetLatestClientUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemInfoApi
+     */
+    systemInfoClientUpdateLatestGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelsOrgNoteClientUpdateInfo, any>>;
     /**
      *
      * @summary GetUpdatesFromVersion

package/remote-api/api.js

@@ -1033,6 +1033,31 @@ export class SyncApi extends BaseAPI {
  */
 export const SystemInfoApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary GetLatestClientUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        systemInfoClientUpdateLatestGet: async (options = {}) => {
+            const localVarPath = `/system-info/client-update/latest`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary GetUpdatesFromVersion
@@ -1100,6 +1125,18 @@ export const SystemInfoApiAxiosParamCreator = function (configuration) {
 export const SystemInfoApiFp = function (configuration) {
     const localVarAxiosParamCreator = SystemInfoApiAxiosParamCreator(configuration);
     return {
+        /**
+         *
+         * @summary GetLatestClientUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async systemInfoClientUpdateLatestGet(options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.systemInfoClientUpdateLatestGet(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SystemInfoApi.systemInfoClientUpdateLatestGet']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary GetUpdatesFromVersion
@@ -1135,6 +1172,15 @@ export const SystemInfoApiFp = function (configuration) {
 export const SystemInfoApiFactory = function (configuration, basePath, axios) {
     const localVarFp = SystemInfoApiFp(configuration);
     return {
+        /**
+         *
+         * @summary GetLatestClientUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        systemInfoClientUpdateLatestGet(options) {
+            return localVarFp.systemInfoClientUpdateLatestGet(options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary GetUpdatesFromVersion
@@ -1164,6 +1210,16 @@ export const SystemInfoApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 export class SystemInfoApi extends BaseAPI {
+    /**
+     *
+     * @summary GetLatestClientUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemInfoApi
+     */
+    systemInfoClientUpdateLatestGet(options) {
+        return SystemInfoApiFp(this.configuration).systemInfoClientUpdateLatestGet(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary GetUpdatesFromVersion