@openfin/fdc3-api 45.100.23 → 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.
@@ -3113,6 +3113,48 @@ declare type ClearCacheOption = {
3113
3113
  localStorage?: boolean;
3114
3114
  };
3115
3115
 
3116
+ /**
3117
+ * @interface
3118
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3119
+ */
3120
+ declare type ClearDataOptions = {
3121
+ /**
3122
+ * The types of data to clear. By default, this will clear all types of data.
3123
+ * This can potentially include data types not explicitly listed here.
3124
+ *
3125
+ * - `backgroundFetch` - Background Fetch
3126
+ * - `cache` - Cache (includes cachestorage and shadercache)
3127
+ * - `cookies` - Cookies
3128
+ * - `downloads` - Downloads
3129
+ * - `fileSystems` - File Systems
3130
+ * - `indexedDB` - IndexedDB
3131
+ * - `localStorage` - Local Storage
3132
+ * - `serviceWorkers` - Service Workers
3133
+ * - `webSQL` - WebSQL
3134
+ */
3135
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3136
+ /**
3137
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3138
+ * Example: ['http://localhost:8081', 'https://example.com']
3139
+ */
3140
+ origins?: string[];
3141
+ /**
3142
+ * Clear data for all origins except these ones. Cannot be used with origins.
3143
+ * Example: ['http://workspace.here.io']
3144
+ */
3145
+ excludeOrigins?: string[];
3146
+ /**
3147
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3148
+ */
3149
+ avoidClosingConnections?: boolean;
3150
+ /**
3151
+ * The behavior for matching data to origins.
3152
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3153
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3154
+ */
3155
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3156
+ };
3157
+
3116
3158
  /**
3117
3159
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3118
3160
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10588,6 +10630,7 @@ declare namespace OpenFin {
10588
10630
  NonAppProcessDetails,
10589
10631
  SystemProcessInfo,
10590
10632
  ClearCacheOption,
10633
+ ClearDataOptions,
10591
10634
  CookieInfo,
10592
10635
  CookieOption,
10593
10636
  CrashReporterOptions,
@@ -13516,6 +13559,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13516
13559
  'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
13517
13560
  'get-version': GetterCall<string>;
13518
13561
  'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
13562
+ 'clear-http-cache': VoidCall;
13563
+ 'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
13519
13564
  'delete-cache-request': VoidCall;
13520
13565
  'exit-desktop': VoidCall;
13521
13566
  'fetch-manifest': ApiCall<{
@@ -15138,6 +15183,44 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15138
15183
  *
15139
15184
  */
15140
15185
  clearCache(options: OpenFin.ClearCacheOption): Promise<void>;
15186
+ /**
15187
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
15188
+ * Service workers and other storage data are preserved.
15189
+ *
15190
+ * This is useful when you need to clear stale content without breaking offline functionality.
15191
+ *
15192
+ * @example
15193
+ * ```js
15194
+ * // Clear HTTP cache without affecting service workers
15195
+ * await fin.System.clearHTTPCache();
15196
+ * ```
15197
+ */
15198
+ clearHTTPCache(): Promise<void>;
15199
+ /**
15200
+ * Clears browsing data with granular control over what to clear and which origins to target.
15201
+ *
15202
+ * @param options - Optional configuration for what data to clear
15203
+ *
15204
+ * @example
15205
+ * ```js
15206
+ * // Clear only cookies and localStorage for a specific origin
15207
+ * await fin.System.clearCacheData({
15208
+ * dataTypes: ['cookies', 'localStorage'],
15209
+ * origins: ['http://localhost:8081']
15210
+ * });
15211
+ *
15212
+ * // Clear everything except for a specific origin
15213
+ * await fin.System.clearCacheData({
15214
+ * excludeOrigins: ['http://example.com']
15215
+ * });
15216
+ *
15217
+ * // Clear all service workers across all origins
15218
+ * await fin.System.clearCacheData({
15219
+ * dataTypes: ['serviceWorkers']
15220
+ * });
15221
+ * ```
15222
+ */
15223
+ clearCacheData(options?: OpenFin.ClearDataOptions): Promise<void>;
15141
15224
  /**
15142
15225
  * Clears all cached data when OpenFin Runtime exits.
15143
15226
  *
@@ -3113,6 +3113,48 @@ declare type ClearCacheOption = {
3113
3113
  localStorage?: boolean;
3114
3114
  };
3115
3115
 
3116
+ /**
3117
+ * @interface
3118
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3119
+ */
3120
+ declare type ClearDataOptions = {
3121
+ /**
3122
+ * The types of data to clear. By default, this will clear all types of data.
3123
+ * This can potentially include data types not explicitly listed here.
3124
+ *
3125
+ * - `backgroundFetch` - Background Fetch
3126
+ * - `cache` - Cache (includes cachestorage and shadercache)
3127
+ * - `cookies` - Cookies
3128
+ * - `downloads` - Downloads
3129
+ * - `fileSystems` - File Systems
3130
+ * - `indexedDB` - IndexedDB
3131
+ * - `localStorage` - Local Storage
3132
+ * - `serviceWorkers` - Service Workers
3133
+ * - `webSQL` - WebSQL
3134
+ */
3135
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3136
+ /**
3137
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3138
+ * Example: ['http://localhost:8081', 'https://example.com']
3139
+ */
3140
+ origins?: string[];
3141
+ /**
3142
+ * Clear data for all origins except these ones. Cannot be used with origins.
3143
+ * Example: ['http://workspace.here.io']
3144
+ */
3145
+ excludeOrigins?: string[];
3146
+ /**
3147
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3148
+ */
3149
+ avoidClosingConnections?: boolean;
3150
+ /**
3151
+ * The behavior for matching data to origins.
3152
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3153
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3154
+ */
3155
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3156
+ };
3157
+
3116
3158
  /**
3117
3159
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3118
3160
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10588,6 +10630,7 @@ declare namespace OpenFin {
10588
10630
  NonAppProcessDetails,
10589
10631
  SystemProcessInfo,
10590
10632
  ClearCacheOption,
10633
+ ClearDataOptions,
10591
10634
  CookieInfo,
10592
10635
  CookieOption,
10593
10636
  CrashReporterOptions,
@@ -13516,6 +13559,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13516
13559
  'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
13517
13560
  'get-version': GetterCall<string>;
13518
13561
  'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
13562
+ 'clear-http-cache': VoidCall;
13563
+ 'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
13519
13564
  'delete-cache-request': VoidCall;
13520
13565
  'exit-desktop': VoidCall;
13521
13566
  'fetch-manifest': ApiCall<{
@@ -15138,6 +15183,44 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15138
15183
  *
15139
15184
  */
15140
15185
  clearCache(options: OpenFin.ClearCacheOption): Promise<void>;
15186
+ /**
15187
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
15188
+ * Service workers and other storage data are preserved.
15189
+ *
15190
+ * This is useful when you need to clear stale content without breaking offline functionality.
15191
+ *
15192
+ * @example
15193
+ * ```js
15194
+ * // Clear HTTP cache without affecting service workers
15195
+ * await fin.System.clearHTTPCache();
15196
+ * ```
15197
+ */
15198
+ clearHTTPCache(): Promise<void>;
15199
+ /**
15200
+ * Clears browsing data with granular control over what to clear and which origins to target.
15201
+ *
15202
+ * @param options - Optional configuration for what data to clear
15203
+ *
15204
+ * @example
15205
+ * ```js
15206
+ * // Clear only cookies and localStorage for a specific origin
15207
+ * await fin.System.clearCacheData({
15208
+ * dataTypes: ['cookies', 'localStorage'],
15209
+ * origins: ['http://localhost:8081']
15210
+ * });
15211
+ *
15212
+ * // Clear everything except for a specific origin
15213
+ * await fin.System.clearCacheData({
15214
+ * excludeOrigins: ['http://example.com']
15215
+ * });
15216
+ *
15217
+ * // Clear all service workers across all origins
15218
+ * await fin.System.clearCacheData({
15219
+ * dataTypes: ['serviceWorkers']
15220
+ * });
15221
+ * ```
15222
+ */
15223
+ clearCacheData(options?: OpenFin.ClearDataOptions): Promise<void>;
15141
15224
  /**
15142
15225
  * Clears all cached data when OpenFin Runtime exits.
15143
15226
  *
@@ -3113,6 +3113,48 @@ declare type ClearCacheOption = {
3113
3113
  localStorage?: boolean;
3114
3114
  };
3115
3115
 
3116
+ /**
3117
+ * @interface
3118
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3119
+ */
3120
+ declare type ClearDataOptions = {
3121
+ /**
3122
+ * The types of data to clear. By default, this will clear all types of data.
3123
+ * This can potentially include data types not explicitly listed here.
3124
+ *
3125
+ * - `backgroundFetch` - Background Fetch
3126
+ * - `cache` - Cache (includes cachestorage and shadercache)
3127
+ * - `cookies` - Cookies
3128
+ * - `downloads` - Downloads
3129
+ * - `fileSystems` - File Systems
3130
+ * - `indexedDB` - IndexedDB
3131
+ * - `localStorage` - Local Storage
3132
+ * - `serviceWorkers` - Service Workers
3133
+ * - `webSQL` - WebSQL
3134
+ */
3135
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3136
+ /**
3137
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3138
+ * Example: ['http://localhost:8081', 'https://example.com']
3139
+ */
3140
+ origins?: string[];
3141
+ /**
3142
+ * Clear data for all origins except these ones. Cannot be used with origins.
3143
+ * Example: ['http://workspace.here.io']
3144
+ */
3145
+ excludeOrigins?: string[];
3146
+ /**
3147
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3148
+ */
3149
+ avoidClosingConnections?: boolean;
3150
+ /**
3151
+ * The behavior for matching data to origins.
3152
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3153
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3154
+ */
3155
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3156
+ };
3157
+
3116
3158
  /**
3117
3159
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3118
3160
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10588,6 +10630,7 @@ declare namespace OpenFin {
10588
10630
  NonAppProcessDetails,
10589
10631
  SystemProcessInfo,
10590
10632
  ClearCacheOption,
10633
+ ClearDataOptions,
10591
10634
  CookieInfo,
10592
10635
  CookieOption,
10593
10636
  CrashReporterOptions,
@@ -13516,6 +13559,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13516
13559
  'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
13517
13560
  'get-version': GetterCall<string>;
13518
13561
  'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
13562
+ 'clear-http-cache': VoidCall;
13563
+ 'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
13519
13564
  'delete-cache-request': VoidCall;
13520
13565
  'exit-desktop': VoidCall;
13521
13566
  'fetch-manifest': ApiCall<{
@@ -15138,6 +15183,44 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15138
15183
  *
15139
15184
  */
15140
15185
  clearCache(options: OpenFin.ClearCacheOption): Promise<void>;
15186
+ /**
15187
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
15188
+ * Service workers and other storage data are preserved.
15189
+ *
15190
+ * This is useful when you need to clear stale content without breaking offline functionality.
15191
+ *
15192
+ * @example
15193
+ * ```js
15194
+ * // Clear HTTP cache without affecting service workers
15195
+ * await fin.System.clearHTTPCache();
15196
+ * ```
15197
+ */
15198
+ clearHTTPCache(): Promise<void>;
15199
+ /**
15200
+ * Clears browsing data with granular control over what to clear and which origins to target.
15201
+ *
15202
+ * @param options - Optional configuration for what data to clear
15203
+ *
15204
+ * @example
15205
+ * ```js
15206
+ * // Clear only cookies and localStorage for a specific origin
15207
+ * await fin.System.clearCacheData({
15208
+ * dataTypes: ['cookies', 'localStorage'],
15209
+ * origins: ['http://localhost:8081']
15210
+ * });
15211
+ *
15212
+ * // Clear everything except for a specific origin
15213
+ * await fin.System.clearCacheData({
15214
+ * excludeOrigins: ['http://example.com']
15215
+ * });
15216
+ *
15217
+ * // Clear all service workers across all origins
15218
+ * await fin.System.clearCacheData({
15219
+ * dataTypes: ['serviceWorkers']
15220
+ * });
15221
+ * ```
15222
+ */
15223
+ clearCacheData(options?: OpenFin.ClearDataOptions): Promise<void>;
15141
15224
  /**
15142
15225
  * Clears all cached data when OpenFin Runtime exits.
15143
15226
  *
package/out/fdc3-api.d.ts CHANGED
@@ -3169,6 +3169,48 @@ declare type ClearCacheOption = {
3169
3169
  localStorage?: boolean;
3170
3170
  };
3171
3171
 
3172
+ /**
3173
+ * @interface
3174
+ * Options for clearing various types of browsing data. Based on Electron's session.clearData() API.
3175
+ */
3176
+ declare type ClearDataOptions = {
3177
+ /**
3178
+ * The types of data to clear. By default, this will clear all types of data.
3179
+ * This can potentially include data types not explicitly listed here.
3180
+ *
3181
+ * - `backgroundFetch` - Background Fetch
3182
+ * - `cache` - Cache (includes cachestorage and shadercache)
3183
+ * - `cookies` - Cookies
3184
+ * - `downloads` - Downloads
3185
+ * - `fileSystems` - File Systems
3186
+ * - `indexedDB` - IndexedDB
3187
+ * - `localStorage` - Local Storage
3188
+ * - `serviceWorkers` - Service Workers
3189
+ * - `webSQL` - WebSQL
3190
+ */
3191
+ dataTypes?: Array<'backgroundFetch' | 'cache' | 'cookies' | 'downloads' | 'fileSystems' | 'indexedDB' | 'localStorage' | 'serviceWorkers' | 'webSQL'>;
3192
+ /**
3193
+ * Clear data for only these origins. Cannot be used with excludeOrigins.
3194
+ * Example: ['http://localhost:8081', 'https://example.com']
3195
+ */
3196
+ origins?: string[];
3197
+ /**
3198
+ * Clear data for all origins except these ones. Cannot be used with origins.
3199
+ * Example: ['http://workspace.here.io']
3200
+ */
3201
+ excludeOrigins?: string[];
3202
+ /**
3203
+ * Skips deleting session/authentication cookies currently maintaining active connections. (Default: false)
3204
+ */
3205
+ avoidClosingConnections?: boolean;
3206
+ /**
3207
+ * The behavior for matching data to origins.
3208
+ * - `third-parties-included` (default) - Storage is matched on origin in first-party contexts and top-level-site in third-party contexts.
3209
+ * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
3210
+ */
3211
+ originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
3212
+ };
3213
+
3172
3214
  /**
3173
3215
  * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
3174
3216
  * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
@@ -10922,6 +10964,7 @@ declare namespace OpenFin {
10922
10964
  NonAppProcessDetails,
10923
10965
  SystemProcessInfo,
10924
10966
  ClearCacheOption,
10967
+ ClearDataOptions,
10925
10968
  CookieInfo,
10926
10969
  CookieOption,
10927
10970
  CrashReporterOptions,
@@ -13933,6 +13976,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
13933
13976
  'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
13934
13977
  'get-version': GetterCall<string>;
13935
13978
  'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
13979
+ 'clear-http-cache': VoidCall;
13980
+ 'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
13936
13981
  'delete-cache-request': VoidCall;
13937
13982
  'exit-desktop': VoidCall;
13938
13983
  'fetch-manifest': ApiCall<{
@@ -15561,6 +15606,44 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15561
15606
  *
15562
15607
  */
15563
15608
  clearCache(options: OpenFin.ClearCacheOption): Promise<void>;
15609
+ /**
15610
+ * Clears only the HTTP cache (browser cache for HTML, CSS, JS, images).
15611
+ * Service workers and other storage data are preserved.
15612
+ *
15613
+ * This is useful when you need to clear stale content without breaking offline functionality.
15614
+ *
15615
+ * @example
15616
+ * ```js
15617
+ * // Clear HTTP cache without affecting service workers
15618
+ * await fin.System.clearHTTPCache();
15619
+ * ```
15620
+ */
15621
+ clearHTTPCache(): Promise<void>;
15622
+ /**
15623
+ * Clears browsing data with granular control over what to clear and which origins to target.
15624
+ *
15625
+ * @param options - Optional configuration for what data to clear
15626
+ *
15627
+ * @example
15628
+ * ```js
15629
+ * // Clear only cookies and localStorage for a specific origin
15630
+ * await fin.System.clearCacheData({
15631
+ * dataTypes: ['cookies', 'localStorage'],
15632
+ * origins: ['http://localhost:8081']
15633
+ * });
15634
+ *
15635
+ * // Clear everything except for a specific origin
15636
+ * await fin.System.clearCacheData({
15637
+ * excludeOrigins: ['http://example.com']
15638
+ * });
15639
+ *
15640
+ * // Clear all service workers across all origins
15641
+ * await fin.System.clearCacheData({
15642
+ * dataTypes: ['serviceWorkers']
15643
+ * });
15644
+ * ```
15645
+ */
15646
+ clearCacheData(options?: OpenFin.ClearDataOptions): Promise<void>;
15564
15647
  /**
15565
15648
  * Clears all cached data when OpenFin Runtime exits.
15566
15649
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "45.100.23",
3
+ "version": "45.100.29",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,