@openfin/core 45.100.27 → 45.100.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3116,6 +3116,48 @@ declare type ClearCacheOption = {
3116
3116
  localStorage?: boolean;
3117
3117
  };
3118
3118
 
3119
+ /**
3120
+ * @interface
3121
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3122
+ */
3123
+ declare type ClearDataOptions = {
3124
+ /**
3125
+ * The types of data to clear. By default, this will clear all types of data.
3126
+ * This can potentially include data types not explicitly listed here.
3127
+ *
3128
+ * - `backgroundFetch` - Background Fetch
3129
+ * - `cache` - Cache (includes cachestorage and shadercache)
3130
+ * - `cookies` - Cookies
3131
+ * - `downloads` - Downloads
3132
+ * - `fileSystems` - File Systems
3133
+ * - `indexedDB` - IndexedDB
3134
+ * - `localStorage` - Local Storage
3135
+ * - `serviceWorkers` - Service Workers
3136
+ * - `webSQL` - WebSQL
3137
+ */
3138
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3139
+ /**
3140
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3141
+ * Example: ['http://localhost:8081', 'https://example.com']
3142
+ */
3143
+ origins?: string[];
3144
+ /**
3145
+ * Clear data for all origins except these ones. Cannot be used with origins.
3146
+ * Example: ['http://workspace.here.io']
3147
+ */
3148
+ excludeOrigins?: string[];
3149
+ /**
3150
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3151
+ */
3152
+ avoidClosingConnections?: boolean;
3153
+ /**
3154
+ * The behavior for matching data to origins.
3155
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3156
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3157
+ */
3158
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3159
+ };
3160
+
3119
3161
  /**
3120
3162
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3121
3163
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10246,6 +10288,7 @@ declare namespace OpenFin_2 {
10246
10288
  NonAppProcessDetails,
10247
10289
  SystemProcessInfo,
10248
10290
  ClearCacheOption,
10291
+ ClearDataOptions,
10249
10292
  CookieInfo,
10250
10293
  CookieOption,
10251
10294
  CrashReporterOptions,
@@ -13176,6 +13219,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13176
13219
  'get-theme-preferences': GetterCall<OpenFin_2.NativeTheme>;
13177
13220
  'get-version': GetterCall<string>;
13178
13221
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
13222
+ 'clear-http-cache': VoidCall;
13223
+ 'clear-cache-data': ApiCall<OpenFin_2.ClearDataOptions, void>;
13179
13224
  'delete-cache-request': VoidCall;
13180
13225
  'exit-desktop': VoidCall;
13181
13226
  'fetch-manifest': ApiCall<{
@@ -14798,6 +14843,44 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14798
14843
  *
14799
14844
  */
14800
14845
  clearCache(options: OpenFin_2.ClearCacheOption): Promise<void>;
14846
+ /**
14847
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
14848
+ * Service workers and other storage data are preserved.
14849
+ *
14850
+ * This is useful when you need to clear stale content without breaking offline functionality.
14851
+ *
14852
+ * @example
14853
+ * ```js
14854
+ * // Clear HTTP cache without affecting service workers
14855
+ * await fin.System.clearHTTPCache();
14856
+ * ```
14857
+ */
14858
+ clearHTTPCache(): Promise<void>;
14859
+ /**
14860
+ * Clears browsing data with granular control over what to clear and which origins to target.
14861
+ *
14862
+ * @param options - Optional configuration for what data to clear
14863
+ *
14864
+ * @example
14865
+ * ```js
14866
+ * // Clear only cookies and localStorage for a specific origin
14867
+ * await fin.System.clearCacheData({
14868
+ * dataTypes: ['cookies', 'localStorage'],
14869
+ * origins: ['http://localhost:8081']
14870
+ * });
14871
+ *
14872
+ * // Clear everything except for a specific origin
14873
+ * await fin.System.clearCacheData({
14874
+ * excludeOrigins: ['http://example.com']
14875
+ * });
14876
+ *
14877
+ * // Clear all service workers across all origins
14878
+ * await fin.System.clearCacheData({
14879
+ * dataTypes: ['serviceWorkers']
14880
+ * });
14881
+ * ```
14882
+ */
14883
+ clearCacheData(options?: OpenFin_2.ClearDataOptions): Promise<void>;
14801
14884
  /**
14802
14885
  * Clears all cached data when OpenFin Runtime exits.
14803
14886
  *
@@ -3116,6 +3116,48 @@ declare type ClearCacheOption = {
3116
3116
  localStorage?: boolean;
3117
3117
  };
3118
3118
 
3119
+ /**
3120
+ * @interface
3121
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3122
+ */
3123
+ declare type ClearDataOptions = {
3124
+ /**
3125
+ * The types of data to clear. By default, this will clear all types of data.
3126
+ * This can potentially include data types not explicitly listed here.
3127
+ *
3128
+ * - `backgroundFetch` - Background Fetch
3129
+ * - `cache` - Cache (includes cachestorage and shadercache)
3130
+ * - `cookies` - Cookies
3131
+ * - `downloads` - Downloads
3132
+ * - `fileSystems` - File Systems
3133
+ * - `indexedDB` - IndexedDB
3134
+ * - `localStorage` - Local Storage
3135
+ * - `serviceWorkers` - Service Workers
3136
+ * - `webSQL` - WebSQL
3137
+ */
3138
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3139
+ /**
3140
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3141
+ * Example: ['http://localhost:8081', 'https://example.com']
3142
+ */
3143
+ origins?: string[];
3144
+ /**
3145
+ * Clear data for all origins except these ones. Cannot be used with origins.
3146
+ * Example: ['http://workspace.here.io']
3147
+ */
3148
+ excludeOrigins?: string[];
3149
+ /**
3150
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3151
+ */
3152
+ avoidClosingConnections?: boolean;
3153
+ /**
3154
+ * The behavior for matching data to origins.
3155
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3156
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3157
+ */
3158
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3159
+ };
3160
+
3119
3161
  /**
3120
3162
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3121
3163
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10246,6 +10288,7 @@ declare namespace OpenFin_2 {
10246
10288
  NonAppProcessDetails,
10247
10289
  SystemProcessInfo,
10248
10290
  ClearCacheOption,
10291
+ ClearDataOptions,
10249
10292
  CookieInfo,
10250
10293
  CookieOption,
10251
10294
  CrashReporterOptions,
@@ -13176,6 +13219,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13176
13219
  'get-theme-preferences': GetterCall<OpenFin_2.NativeTheme>;
13177
13220
  'get-version': GetterCall<string>;
13178
13221
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
13222
+ 'clear-http-cache': VoidCall;
13223
+ 'clear-cache-data': ApiCall<OpenFin_2.ClearDataOptions, void>;
13179
13224
  'delete-cache-request': VoidCall;
13180
13225
  'exit-desktop': VoidCall;
13181
13226
  'fetch-manifest': ApiCall<{
@@ -14798,6 +14843,44 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14798
14843
  *
14799
14844
  */
14800
14845
  clearCache(options: OpenFin_2.ClearCacheOption): Promise<void>;
14846
+ /**
14847
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
14848
+ * Service workers and other storage data are preserved.
14849
+ *
14850
+ * This is useful when you need to clear stale content without breaking offline functionality.
14851
+ *
14852
+ * @example
14853
+ * ```js
14854
+ * // Clear HTTP cache without affecting service workers
14855
+ * await fin.System.clearHTTPCache();
14856
+ * ```
14857
+ */
14858
+ clearHTTPCache(): Promise<void>;
14859
+ /**
14860
+ * Clears browsing data with granular control over what to clear and which origins to target.
14861
+ *
14862
+ * @param options - Optional configuration for what data to clear
14863
+ *
14864
+ * @example
14865
+ * ```js
14866
+ * // Clear only cookies and localStorage for a specific origin
14867
+ * await fin.System.clearCacheData({
14868
+ * dataTypes: ['cookies', 'localStorage'],
14869
+ * origins: ['http://localhost:8081']
14870
+ * });
14871
+ *
14872
+ * // Clear everything except for a specific origin
14873
+ * await fin.System.clearCacheData({
14874
+ * excludeOrigins: ['http://example.com']
14875
+ * });
14876
+ *
14877
+ * // Clear all service workers across all origins
14878
+ * await fin.System.clearCacheData({
14879
+ * dataTypes: ['serviceWorkers']
14880
+ * });
14881
+ * ```
14882
+ */
14883
+ clearCacheData(options?: OpenFin_2.ClearDataOptions): Promise<void>;
14801
14884
  /**
14802
14885
  * Clears all cached data when OpenFin Runtime exits.
14803
14886
  *
@@ -3116,6 +3116,48 @@ declare type ClearCacheOption = {
3116
3116
  localStorage?: boolean;
3117
3117
  };
3118
3118
 
3119
+ /**
3120
+ * @interface
3121
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3122
+ */
3123
+ declare type ClearDataOptions = {
3124
+ /**
3125
+ * The types of data to clear. By default, this will clear all types of data.
3126
+ * This can potentially include data types not explicitly listed here.
3127
+ *
3128
+ * - `backgroundFetch` - Background Fetch
3129
+ * - `cache` - Cache (includes cachestorage and shadercache)
3130
+ * - `cookies` - Cookies
3131
+ * - `downloads` - Downloads
3132
+ * - `fileSystems` - File Systems
3133
+ * - `indexedDB` - IndexedDB
3134
+ * - `localStorage` - Local Storage
3135
+ * - `serviceWorkers` - Service Workers
3136
+ * - `webSQL` - WebSQL
3137
+ */
3138
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3139
+ /**
3140
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3141
+ * Example: ['http://localhost:8081', 'https://example.com']
3142
+ */
3143
+ origins?: string[];
3144
+ /**
3145
+ * Clear data for all origins except these ones. Cannot be used with origins.
3146
+ * Example: ['http://workspace.here.io']
3147
+ */
3148
+ excludeOrigins?: string[];
3149
+ /**
3150
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3151
+ */
3152
+ avoidClosingConnections?: boolean;
3153
+ /**
3154
+ * The behavior for matching data to origins.
3155
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3156
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3157
+ */
3158
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3159
+ };
3160
+
3119
3161
  /**
3120
3162
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3121
3163
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10246,6 +10288,7 @@ declare namespace OpenFin_2 {
10246
10288
  NonAppProcessDetails,
10247
10289
  SystemProcessInfo,
10248
10290
  ClearCacheOption,
10291
+ ClearDataOptions,
10249
10292
  CookieInfo,
10250
10293
  CookieOption,
10251
10294
  CrashReporterOptions,
@@ -13176,6 +13219,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13176
13219
  'get-theme-preferences': GetterCall<OpenFin_2.NativeTheme>;
13177
13220
  'get-version': GetterCall<string>;
13178
13221
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
13222
+ 'clear-http-cache': VoidCall;
13223
+ 'clear-cache-data': ApiCall<OpenFin_2.ClearDataOptions, void>;
13179
13224
  'delete-cache-request': VoidCall;
13180
13225
  'exit-desktop': VoidCall;
13181
13226
  'fetch-manifest': ApiCall<{
@@ -14798,6 +14843,44 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14798
14843
  *
14799
14844
  */
14800
14845
  clearCache(options: OpenFin_2.ClearCacheOption): Promise<void>;
14846
+ /**
14847
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
14848
+ * Service workers and other storage data are preserved.
14849
+ *
14850
+ * This is useful when you need to clear stale content without breaking offline functionality.
14851
+ *
14852
+ * @example
14853
+ * ```js
14854
+ * // Clear HTTP cache without affecting service workers
14855
+ * await fin.System.clearHTTPCache();
14856
+ * ```
14857
+ */
14858
+ clearHTTPCache(): Promise<void>;
14859
+ /**
14860
+ * Clears browsing data with granular control over what to clear and which origins to target.
14861
+ *
14862
+ * @param options - Optional configuration for what data to clear
14863
+ *
14864
+ * @example
14865
+ * ```js
14866
+ * // Clear only cookies and localStorage for a specific origin
14867
+ * await fin.System.clearCacheData({
14868
+ * dataTypes: ['cookies', 'localStorage'],
14869
+ * origins: ['http://localhost:8081']
14870
+ * });
14871
+ *
14872
+ * // Clear everything except for a specific origin
14873
+ * await fin.System.clearCacheData({
14874
+ * excludeOrigins: ['http://example.com']
14875
+ * });
14876
+ *
14877
+ * // Clear all service workers across all origins
14878
+ * await fin.System.clearCacheData({
14879
+ * dataTypes: ['serviceWorkers']
14880
+ * });
14881
+ * ```
14882
+ */
14883
+ clearCacheData(options?: OpenFin_2.ClearDataOptions): Promise<void>;
14801
14884
  /**
14802
14885
  * Clears all cached data when OpenFin Runtime exits.
14803
14886
  *
package/out/stub.d.ts CHANGED
@@ -3172,6 +3172,48 @@ declare type ClearCacheOption = {
3172
3172
  localStorage?: boolean;
3173
3173
  };
3174
3174
 
3175
+ /**
3176
+ * @interface
3177
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3178
+ */
3179
+ declare type ClearDataOptions = {
3180
+ /**
3181
+ * The types of data to clear. By default, this will clear all types of data.
3182
+ * This can potentially include data types not explicitly listed here.
3183
+ *
3184
+ * - `backgroundFetch` - Background Fetch
3185
+ * - `cache` - Cache (includes cachestorage and shadercache)
3186
+ * - `cookies` - Cookies
3187
+ * - `downloads` - Downloads
3188
+ * - `fileSystems` - File Systems
3189
+ * - `indexedDB` - IndexedDB
3190
+ * - `localStorage` - Local Storage
3191
+ * - `serviceWorkers` - Service Workers
3192
+ * - `webSQL` - WebSQL
3193
+ */
3194
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3195
+ /**
3196
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3197
+ * Example: ['http://localhost:8081', 'https://example.com']
3198
+ */
3199
+ origins?: string[];
3200
+ /**
3201
+ * Clear data for all origins except these ones. Cannot be used with origins.
3202
+ * Example: ['http://workspace.here.io']
3203
+ */
3204
+ excludeOrigins?: string[];
3205
+ /**
3206
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3207
+ */
3208
+ avoidClosingConnections?: boolean;
3209
+ /**
3210
+ * The behavior for matching data to origins.
3211
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3212
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3213
+ */
3214
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3215
+ };
3216
+
3175
3217
  /**
3176
3218
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3177
3219
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10580,6 +10622,7 @@ declare namespace OpenFin_2 {
10580
10622
  NonAppProcessDetails,
10581
10623
  SystemProcessInfo,
10582
10624
  ClearCacheOption,
10625
+ ClearDataOptions,
10583
10626
  CookieInfo,
10584
10627
  CookieOption,
10585
10628
  CrashReporterOptions,
@@ -13593,6 +13636,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13593
13636
  'get-theme-preferences': GetterCall<OpenFin_2.NativeTheme>;
13594
13637
  'get-version': GetterCall<string>;
13595
13638
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
13639
+ 'clear-http-cache': VoidCall;
13640
+ 'clear-cache-data': ApiCall<OpenFin_2.ClearDataOptions, void>;
13596
13641
  'delete-cache-request': VoidCall;
13597
13642
  'exit-desktop': VoidCall;
13598
13643
  'fetch-manifest': ApiCall<{
@@ -15221,6 +15266,44 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
15221
15266
  *
15222
15267
  */
15223
15268
  clearCache(options: OpenFin_2.ClearCacheOption): Promise<void>;
15269
+ /**
15270
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
15271
+ * Service workers and other storage data are preserved.
15272
+ *
15273
+ * This is useful when you need to clear stale content without breaking offline functionality.
15274
+ *
15275
+ * @example
15276
+ * ```js
15277
+ * // Clear HTTP cache without affecting service workers
15278
+ * await fin.System.clearHTTPCache();
15279
+ * ```
15280
+ */
15281
+ clearHTTPCache(): Promise<void>;
15282
+ /**
15283
+ * Clears browsing data with granular control over what to clear and which origins to target.
15284
+ *
15285
+ * @param options - Optional configuration for what data to clear
15286
+ *
15287
+ * @example
15288
+ * ```js
15289
+ * // Clear only cookies and localStorage for a specific origin
15290
+ * await fin.System.clearCacheData({
15291
+ * dataTypes: ['cookies', 'localStorage'],
15292
+ * origins: ['http://localhost:8081']
15293
+ * });
15294
+ *
15295
+ * // Clear everything except for a specific origin
15296
+ * await fin.System.clearCacheData({
15297
+ * excludeOrigins: ['http://example.com']
15298
+ * });
15299
+ *
15300
+ * // Clear all service workers across all origins
15301
+ * await fin.System.clearCacheData({
15302
+ * dataTypes: ['serviceWorkers']
15303
+ * });
15304
+ * ```
15305
+ */
15306
+ clearCacheData(options?: OpenFin_2.ClearDataOptions): Promise<void>;
15224
15307
  /**
15225
15308
  * Clears all cached data when OpenFin Runtime exits.
15226
15309
  *
package/out/stub.js CHANGED
@@ -5552,6 +5552,48 @@ class System extends base_1$m.EmitterBase {
5552
5552
  clearCache(options) {
5553
5553
  return this.wire.sendAction('clear-cache', options).then(() => undefined);
5554
5554
  }
5555
+ /**
5556
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
5557
+ * Service workers and other storage data are preserved.
5558
+ *
5559
+ * This is useful when you need to clear stale content without breaking offline functionality.
5560
+ *
5561
+ * @example
5562
+ * ```js
5563
+ * // Clear HTTP cache without affecting service workers
5564
+ * await fin.System.clearHTTPCache();
5565
+ * ```
5566
+ */
5567
+ clearHTTPCache() {
5568
+ return this.wire.sendAction('clear-http-cache').then(() => undefined);
5569
+ }
5570
+ /**
5571
+ * Clears browsing data with granular control over what to clear and which origins to target.
5572
+ *
5573
+ * @param options - Optional configuration for what data to clear
5574
+ *
5575
+ * @example
5576
+ * ```js
5577
+ * // Clear only cookies and localStorage for a specific origin
5578
+ * await fin.System.clearCacheData({
5579
+ * dataTypes: ['cookies', 'localStorage'],
5580
+ * origins: ['http://localhost:8081']
5581
+ * });
5582
+ *
5583
+ * // Clear everything except for a specific origin
5584
+ * await fin.System.clearCacheData({
5585
+ * excludeOrigins: ['http://example.com']
5586
+ * });
5587
+ *
5588
+ * // Clear all service workers across all origins
5589
+ * await fin.System.clearCacheData({
5590
+ * dataTypes: ['serviceWorkers']
5591
+ * });
5592
+ * ```
5593
+ */
5594
+ clearCacheData(options) {
5595
+ return this.wire.sendAction('clear-cache-data', options || {}).then(() => undefined);
5596
+ }
5555
5597
  /**
5556
5598
  * Clears all cached data when OpenFin Runtime exits.
5557
5599
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "45.100.27",
3
+ "version": "45.100.29",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",