@arsedizioni/ars-utils 22.0.34 → 22.0.36
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.
- package/clipper.common/README.md +74 -74
- package/fesm2022/arsedizioni-ars-utils-clipper.common.mjs +1013 -695
- package/fesm2022/arsedizioni-ars-utils-clipper.common.mjs.map +1 -1
- package/fesm2022/arsedizioni-ars-utils-clipper.ui.mjs +122 -152
- package/fesm2022/arsedizioni-ars-utils-clipper.ui.mjs.map +1 -1
- package/fesm2022/arsedizioni-ars-utils-evolution.common.mjs +13 -8
- package/fesm2022/arsedizioni-ars-utils-evolution.common.mjs.map +1 -1
- package/fesm2022/arsedizioni-ars-utils-help.mjs +5 -6
- package/fesm2022/arsedizioni-ars-utils-help.mjs.map +1 -1
- package/fesm2022/arsedizioni-ars-utils-support.common.mjs +8 -6
- package/fesm2022/arsedizioni-ars-utils-support.common.mjs.map +1 -1
- package/fesm2022/arsedizioni-ars-utils-support.ui.mjs +5 -7
- package/fesm2022/arsedizioni-ars-utils-support.ui.mjs.map +1 -1
- package/package.json +1 -1
- package/types/arsedizioni-ars-utils-clipper.common.d.ts +455 -286
- package/types/arsedizioni-ars-utils-clipper.ui.d.ts +24 -17
- package/types/arsedizioni-ars-utils-evolution.common.d.ts +4 -4
- package/types/arsedizioni-ars-utils-support.common.d.ts +3 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import { Signal } from '@angular/core';
|
|
3
|
-
import { NameValueItem, Folder, QueryModel,
|
|
1
|
+
import * as i0 from '@angular/core';
|
|
2
|
+
import { Signal, WritableSignal } from '@angular/core';
|
|
3
|
+
import { NameValueItem, Folder, QueryModel, QueryResultModel, LoginResult, ApiResult, UpdateResultModel, FolderTree } from '@arsedizioni/ars-utils/core';
|
|
4
4
|
import { SendToDialogResult } from '@arsedizioni/ars-utils/ui.application';
|
|
5
5
|
import { LoginOAuthType } from '@arsedizioni/ars-utils/ui.oauth';
|
|
6
6
|
import * as _angular_common_http from '@angular/common/http';
|
|
@@ -679,7 +679,7 @@ interface ClipperDashboardResult {
|
|
|
679
679
|
channels?: ClipperChannelSettings[];
|
|
680
680
|
}
|
|
681
681
|
declare class ClipperDashboard {
|
|
682
|
-
items:
|
|
682
|
+
items: i0.WritableSignal<ClipperDashboardItem[]>;
|
|
683
683
|
isTrial?: boolean;
|
|
684
684
|
expiredDeadlines?: number;
|
|
685
685
|
expiringDeadlines?: number;
|
|
@@ -1127,108 +1127,56 @@ declare class ClipperAuthInterceptor implements HttpInterceptor {
|
|
|
1127
1127
|
/**
|
|
1128
1128
|
* Processes an HTTP error, broadcasting a user-friendly message when appropriate.
|
|
1129
1129
|
* Errors are debounced: only one message is sent per `ERROR_DEBOUNCE_MS` window.
|
|
1130
|
+
*
|
|
1131
|
+
* This handler only ever runs for requests already targeting the Clipper service
|
|
1132
|
+
* (see `intercept`). A transport-level failure produces an `HttpErrorResponse`
|
|
1133
|
+
* with status `0` and a `null` url, so the url is only validated when present —
|
|
1134
|
+
* that way genuine network failures still surface the "service unavailable" message.
|
|
1130
1135
|
* @param error - The raw error value thrown by the HTTP layer.
|
|
1131
1136
|
*/
|
|
1132
1137
|
private handleError;
|
|
1133
|
-
static ɵfac:
|
|
1134
|
-
static ɵprov:
|
|
1138
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperAuthInterceptor, never>;
|
|
1139
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperAuthInterceptor>;
|
|
1135
1140
|
}
|
|
1136
1141
|
|
|
1137
|
-
|
|
1142
|
+
/**
|
|
1143
|
+
* Account management: password reset/recovery, settings, channel activation, trial info
|
|
1144
|
+
* and user links. Channel state lives in `ClipperCoreService`; the channel-mutating
|
|
1145
|
+
* helpers (`setChannels`, `setChannelsState`, `updateChannels`) live here.
|
|
1146
|
+
*/
|
|
1147
|
+
declare class ClipperAccountService {
|
|
1138
1148
|
private readonly httpClient;
|
|
1139
|
-
private readonly destroyRef;
|
|
1140
1149
|
private readonly broadcastService;
|
|
1141
|
-
private readonly
|
|
1142
|
-
private broadcastInitialized;
|
|
1143
|
-
private _appUri?;
|
|
1144
|
-
get appUri(): string | undefined;
|
|
1145
|
-
private _serviceUri;
|
|
1146
|
-
get serviceUri(): string;
|
|
1147
|
-
private _flags;
|
|
1148
|
-
get flags(): ClipperServiceFlags;
|
|
1149
|
-
private _loginInfo?;
|
|
1150
|
-
get loginInfo(): ClipperLoginInfo | undefined;
|
|
1151
|
-
private readonly _loggedIn;
|
|
1152
|
-
readonly loggedIn: Signal<boolean>;
|
|
1153
|
-
readonly loggingIn: _angular_core.WritableSignal<boolean>;
|
|
1154
|
-
readonly snapshot: _angular_core.WritableSignal<ClipperSearchResult>;
|
|
1155
|
-
readonly supportsRS: _angular_core.WritableSignal<boolean>;
|
|
1156
|
-
readonly referencesSnapshot: _angular_core.WritableSignal<ClipperSearchResult>;
|
|
1157
|
-
readonly dashboard: ClipperDashboard;
|
|
1158
|
-
readonly bag: _angular_core.WritableSignal<ClipperDocumentInfo[]>;
|
|
1159
|
-
readonly bagTotal: Signal<number>;
|
|
1160
|
-
readonly visible: _angular_core.WritableSignal<boolean>;
|
|
1161
|
-
private _teams;
|
|
1162
|
-
get teams(): NameValueItem<string>[];
|
|
1163
|
-
readonly availableChannels: _angular_core.WritableSignal<ClipperAvailableChannel[]>;
|
|
1164
|
-
readonly activeChannels: Signal<ClipperAvailableChannel[]>;
|
|
1165
|
-
readonly allowTags: _angular_core.WritableSignal<boolean>;
|
|
1166
|
-
readonly pendingNotes: _angular_core.WritableSignal<number>;
|
|
1167
|
-
/**
|
|
1168
|
-
* Initialises the service with the API base URI, optional app URI, and feature flags.
|
|
1169
|
-
* @param serviceUri - The base URI of the Clipper REST API.
|
|
1170
|
-
* @param appUri - Optional URI of the Clipper web application (used to build document links).
|
|
1171
|
-
* @param flags - Feature flags that control service behaviour. Defaults to `ClipperServiceFlags.None`.
|
|
1172
|
-
*/
|
|
1173
|
-
initialize(serviceUri: string, appUri?: string, flags?: ClipperServiceFlags): void;
|
|
1174
|
-
/**
|
|
1175
|
-
* Ping
|
|
1176
|
-
*/
|
|
1177
|
-
ping(): void;
|
|
1178
|
-
/**
|
|
1179
|
-
* Persists the current login context to `localStorage`.
|
|
1180
|
-
*/
|
|
1181
|
-
storeContext(): void;
|
|
1182
|
-
/**
|
|
1183
|
-
* Updates the stored login context with the values from a fresh login result.
|
|
1184
|
-
* @param result - The login result containing the new user context and channel settings.
|
|
1185
|
-
*/
|
|
1186
|
-
updateContext(result: ClipperLoginResult): void;
|
|
1150
|
+
private readonly core;
|
|
1187
1151
|
/**
|
|
1188
|
-
*
|
|
1189
|
-
* @param
|
|
1190
|
-
|
|
1191
|
-
autoLogin(onSuccess?: (value?: any) => void): void;
|
|
1192
|
-
/**
|
|
1193
|
-
* Performs an automatic logout and clears the stored session.
|
|
1194
|
-
* @param onSuccess - Optional callback invoked after a successful logout.
|
|
1195
|
-
*/
|
|
1196
|
-
autoLogout(onSuccess?: () => void): void;
|
|
1197
|
-
/**
|
|
1198
|
-
* Authenticates the user against the Clipper API, supporting both credential-based and
|
|
1199
|
-
* OAuth2 login flows.
|
|
1200
|
-
* @param email - The user's email address (credential login only).
|
|
1201
|
-
* @param password - The user's password (credential login only).
|
|
1202
|
-
* @param remember - When `true`, the session is remembered across browser restarts.
|
|
1203
|
-
* @param oauth - The OAuth2 provider type, when authenticating via SSO.
|
|
1204
|
-
* @param oauthAccessToken - The OAuth2 bearer token. Defaults to the value stored in session storage.
|
|
1152
|
+
* Resets the user's password using the provided parameters.
|
|
1153
|
+
* @param params - The new password and confirmation data.
|
|
1154
|
+
* @returns An observable emitting the API result wrapping the reset password payload.
|
|
1205
1155
|
*/
|
|
1206
|
-
|
|
1156
|
+
resetPassword(params: ResetPasswordDialogResult): rxjs.Observable<ApiResult<ResetPasswordDialogResult>>;
|
|
1207
1157
|
/**
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
* @
|
|
1158
|
+
* Initiates a password recovery flow by sending a reset link to the user's email.
|
|
1159
|
+
* @param params - The password recovery request data.
|
|
1160
|
+
* @returns An observable emitting the API result wrapping a boolean success flag.
|
|
1211
1161
|
*/
|
|
1212
|
-
|
|
1162
|
+
recoverPassword(params: RecoverPasswordDialogResult): rxjs.Observable<ApiResult<boolean>>;
|
|
1213
1163
|
/**
|
|
1214
|
-
*
|
|
1215
|
-
* @
|
|
1164
|
+
* Gets the current user account settings.
|
|
1165
|
+
* @returns An observable emitting the API result wrapping the account settings.
|
|
1216
1166
|
*/
|
|
1217
|
-
|
|
1218
|
-
/**
|
|
1219
|
-
* Logs the user out and clears the current session.
|
|
1220
|
-
* @param forget - When `true`, all stored user credentials are also removed.
|
|
1221
|
-
*/
|
|
1222
|
-
logout(forget?: boolean): rxjs.Observable<any>;
|
|
1167
|
+
getSettings(): rxjs.Observable<ApiResult<ClipperSettingsInfo>>;
|
|
1223
1168
|
/**
|
|
1224
|
-
*
|
|
1169
|
+
* Updates user account settings and applies any channel configuration changes.
|
|
1170
|
+
* @param params - A map of settings key-value pairs to update.
|
|
1171
|
+
* @returns An observable emitting the API result wrapping a boolean success flag.
|
|
1225
1172
|
*/
|
|
1226
|
-
|
|
1173
|
+
updateSettings(params: ClipperSettingsInfo): rxjs.Observable<ApiResult<boolean>>;
|
|
1227
1174
|
/**
|
|
1228
|
-
*
|
|
1229
|
-
* @param
|
|
1175
|
+
* Saves updated channel activation states to the server and applies the new dashboard result.
|
|
1176
|
+
* @param params - The channel state update parameters.
|
|
1177
|
+
* @returns An observable emitting the API result wrapping the dashboard result.
|
|
1230
1178
|
*/
|
|
1231
|
-
|
|
1179
|
+
updateChannelsState(params: ClipperUpdateChannelsStateParams): rxjs.Observable<ApiResult<ClipperDashboardResult>>;
|
|
1232
1180
|
/**
|
|
1233
1181
|
* Applies a new dashboard result: updates channel settings, dashboard counters, and
|
|
1234
1182
|
* re-initialises the available-channels signal.
|
|
@@ -1240,119 +1188,41 @@ declare class ClipperService {
|
|
|
1240
1188
|
* @param channels - The new channel settings to store and activate.
|
|
1241
1189
|
*/
|
|
1242
1190
|
setChannels(channels: ClipperChannelSettings[]): void;
|
|
1243
|
-
/**
|
|
1244
|
-
* Rebuilds the `availableChannels` signal from the current login context.
|
|
1245
|
-
*/
|
|
1246
|
-
private initializeChannels;
|
|
1247
1191
|
/**
|
|
1248
1192
|
* Toggles the active state of available channels based on the supplied selection list.
|
|
1249
1193
|
* @param values - The selected channel items; channels absent from this list are deactivated.
|
|
1250
1194
|
*/
|
|
1251
1195
|
updateChannels(values: NameValueItem<ClipperChannel>[]): void;
|
|
1252
1196
|
/**
|
|
1253
|
-
*
|
|
1254
|
-
* @
|
|
1255
|
-
*/
|
|
1256
|
-
newOTP(id: string): rxjs.Observable<ApiResult<ClipperOTPInfo>>;
|
|
1257
|
-
/**
|
|
1258
|
-
* Load Ars events calendar
|
|
1259
|
-
*/
|
|
1260
|
-
events(params: ClipperSearchArsEventsParams): rxjs.Observable<ApiResult<ClipperSearchArsEventsResult>>;
|
|
1261
|
-
/**
|
|
1262
|
-
* Query documents
|
|
1263
|
-
*/
|
|
1264
|
-
query(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperSearchResult>>;
|
|
1265
|
-
/**
|
|
1266
|
-
* Get facets for a query
|
|
1267
|
-
*/
|
|
1268
|
-
queryFacets(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperSearchFacetsResult>>;
|
|
1269
|
-
/**
|
|
1270
|
-
* Update document state
|
|
1271
|
-
*/
|
|
1272
|
-
updateState(params: ClipperDocumentUpdateStateParams): rxjs.Observable<ApiResult<number>>;
|
|
1273
|
-
/**
|
|
1274
|
-
* Export a document in pdf format
|
|
1275
|
-
*/
|
|
1276
|
-
exportPdf(id: string): rxjs.Observable<Blob>;
|
|
1277
|
-
/**
|
|
1278
|
-
* Export document list (query or selected items) or export deadlines as ics
|
|
1279
|
-
*/
|
|
1280
|
-
export(params: ClipperExportDocumentsParams): rxjs.Observable<Blob>;
|
|
1281
|
-
/**
|
|
1282
|
-
* Send documents link by email
|
|
1283
|
-
*/
|
|
1284
|
-
sendTo(params: ClipperSendDocumentsByEmailParams): rxjs.Observable<ApiResult<number>>;
|
|
1285
|
-
/**
|
|
1286
|
-
* Sends an email notification about a document note update to the specified recipients.
|
|
1287
|
-
* @param params - The notification parameters including recipients and note details.
|
|
1197
|
+
* Gets the trial info for the current account.
|
|
1198
|
+
* @returns An observable emitting the API result wrapping the trial info.
|
|
1288
1199
|
*/
|
|
1289
|
-
|
|
1290
|
-
/**
|
|
1291
|
-
* Display a page the full document report
|
|
1292
|
-
*/
|
|
1293
|
-
report(id: string): rxjs.Observable<Blob>;
|
|
1294
|
-
/**
|
|
1295
|
-
* Get document comment
|
|
1296
|
-
*/
|
|
1297
|
-
comment(id: string): rxjs.Observable<ApiResult<string>>;
|
|
1298
|
-
/**
|
|
1299
|
-
* Get document info
|
|
1300
|
-
*/
|
|
1301
|
-
info(id: string): rxjs.Observable<ApiResult<ClipperDocumentInfo>>;
|
|
1302
|
-
/**
|
|
1303
|
-
* Get document structure
|
|
1304
|
-
*/
|
|
1305
|
-
index(id: string): rxjs.Observable<ApiResult<ClipperDocumentStructure>>;
|
|
1306
|
-
/**
|
|
1307
|
-
* Get document last update
|
|
1308
|
-
*/
|
|
1309
|
-
metadata(id: string): rxjs.Observable<ApiResult<{
|
|
1310
|
-
item1?: string;
|
|
1311
|
-
item2?: ClipperDocumentNote[];
|
|
1312
|
-
}>>;
|
|
1313
|
-
/**
|
|
1314
|
-
* Query document references
|
|
1315
|
-
*/
|
|
1316
|
-
references(params: ClipperReferencesSearchParams): rxjs.Observable<ApiResult<ClipperSearchResult>>;
|
|
1317
|
-
/**
|
|
1318
|
-
* Get facets for a document references
|
|
1319
|
-
*/
|
|
1320
|
-
referencesFacets(params: ClipperReferencesSearchParams): rxjs.Observable<ApiResult<ClipperSearchFacetsResult>>;
|
|
1321
|
-
/**
|
|
1322
|
-
* Wrap document rendering to allow token refresh
|
|
1323
|
-
*/
|
|
1324
|
-
preRender(): rxjs.Observable<ApiResult<boolean>>;
|
|
1200
|
+
private getTrialInfo;
|
|
1325
1201
|
/**
|
|
1326
|
-
*
|
|
1202
|
+
* Refreshes the trial status from the server and updates the stored login context.
|
|
1327
1203
|
*/
|
|
1328
|
-
|
|
1329
|
-
/**
|
|
1330
|
-
* Get deadlines snapshot based on the deadlines
|
|
1331
|
-
*/
|
|
1332
|
-
deadlinesSnapshot(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperSearchCalendarSnapshotResult>>;
|
|
1204
|
+
updateTrialInfo(): void;
|
|
1333
1205
|
/**
|
|
1334
|
-
*
|
|
1206
|
+
* Creates or updates a user link record.
|
|
1207
|
+
* @param item - The user link data to save.
|
|
1208
|
+
* @returns An observable emitting the API result wrapping a boolean success flag.
|
|
1335
1209
|
*/
|
|
1336
|
-
|
|
1210
|
+
saveLink(item: ClipperUserLink): rxjs.Observable<ApiResult<boolean>>;
|
|
1337
1211
|
/**
|
|
1338
|
-
*
|
|
1212
|
+
* Deletes a user link record.
|
|
1213
|
+
* @param item - The user link to remove.
|
|
1214
|
+
* @returns An observable emitting the API result wrapping a boolean success flag.
|
|
1339
1215
|
*/
|
|
1340
|
-
|
|
1341
|
-
/**
|
|
1342
|
-
* Retrieve topics as tree
|
|
1343
|
-
*/
|
|
1344
|
-
getTopicsAsTree(): rxjs.Observable<ApiResult<FolderTree>>;
|
|
1216
|
+
deleteLink(item: ClipperUserLink): rxjs.Observable<ApiResult<boolean>>;
|
|
1345
1217
|
/**
|
|
1346
|
-
*
|
|
1218
|
+
* Retrieves the current dashboard and applies its counters to the shared dashboard state.
|
|
1219
|
+
* @returns The subscription to the dashboard request.
|
|
1347
1220
|
*/
|
|
1348
|
-
getTags(): rxjs.Observable<ApiResult<NameValueItem<string>[]>>;
|
|
1349
|
-
/**
|
|
1350
|
-
* Retrieve current dashboard
|
|
1351
|
-
*/
|
|
1352
1221
|
loadDashboard(): rxjs.Subscription;
|
|
1353
1222
|
/**
|
|
1354
1223
|
* Retrieves documents updated in the last 15 days for the given search parameters.
|
|
1355
1224
|
* @param params - The search parameters to filter results.
|
|
1225
|
+
* @returns An observable emitting the API result wrapping the last-days result.
|
|
1356
1226
|
*/
|
|
1357
1227
|
last15Days(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperLastDaysResult>>;
|
|
1358
1228
|
/**
|
|
@@ -1362,240 +1232,539 @@ declare class ClipperService {
|
|
|
1362
1232
|
* @param increment - The signed increment to apply (use negative values to decrement).
|
|
1363
1233
|
*/
|
|
1364
1234
|
updateUnreadItems(module: ClipperModule, model?: ClipperModel, increment?: number): void;
|
|
1235
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperAccountService, never>;
|
|
1236
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperAccountService>;
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Document archive: folders and files search, save, copy, delete, import/export and download.
|
|
1241
|
+
*/
|
|
1242
|
+
declare class ClipperArchiveService {
|
|
1243
|
+
private readonly httpClient;
|
|
1244
|
+
private readonly core;
|
|
1365
1245
|
/**
|
|
1366
|
-
*
|
|
1367
|
-
|
|
1368
|
-
loadBag(): rxjs.Subscription;
|
|
1369
|
-
/**
|
|
1370
|
-
* Adds one or more documents to the working documents bag.
|
|
1371
|
-
* @param documentIds - The IDs of the documents to add.
|
|
1372
|
-
*/
|
|
1373
|
-
addToBag(documentIds: string[]): rxjs.Subscription;
|
|
1374
|
-
/**
|
|
1375
|
-
* Removes a document from the working documents bag.
|
|
1376
|
-
* @param documentId - The ID of the document to remove.
|
|
1377
|
-
*/
|
|
1378
|
-
removeFromBag(documentId: string): rxjs.Subscription;
|
|
1379
|
-
/**
|
|
1380
|
-
* Clear all working documents
|
|
1381
|
-
*/
|
|
1382
|
-
clearBag(): rxjs.Subscription;
|
|
1383
|
-
/**
|
|
1384
|
-
* Retrieves the saved searches for the given module.
|
|
1385
|
-
* @param module - The Clipper module whose saved searches to load.
|
|
1386
|
-
*/
|
|
1387
|
-
loadSearches(module: ClipperModule): rxjs.Observable<ApiResult<ClipperUserSearch[]>>;
|
|
1388
|
-
/**
|
|
1389
|
-
* Persists a user search configuration on the server.
|
|
1390
|
-
* @param params - The search configuration to save.
|
|
1391
|
-
*/
|
|
1392
|
-
saveSearch(params: ClipperUserSearch): rxjs.Observable<ApiResult<ClipperUserSearch>>;
|
|
1393
|
-
/**
|
|
1394
|
-
* Deletes a saved search by its ID.
|
|
1395
|
-
* @param id - The ID of the saved search to remove.
|
|
1396
|
-
*/
|
|
1397
|
-
deleteSearch(id: number): rxjs.Observable<ApiResult<number>>;
|
|
1398
|
-
/**
|
|
1399
|
-
* Query calendar
|
|
1400
|
-
*/
|
|
1401
|
-
queryCalendar(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperCalendarSearchResult>>;
|
|
1402
|
-
/**
|
|
1403
|
-
* Get the calendar snapshot
|
|
1404
|
-
*/
|
|
1405
|
-
calendarSnapshot(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperSearchCalendarSnapshotResult>>;
|
|
1406
|
-
/**
|
|
1407
|
-
* Deletes one or more calendar deadlines by ID.
|
|
1408
|
-
* @param ids - The IDs of the deadlines to delete.
|
|
1409
|
-
*/
|
|
1410
|
-
deleteCalendarDeadlines(ids: string[]): rxjs.Observable<ApiResult<number>>;
|
|
1411
|
-
/**
|
|
1412
|
-
* Copies one or more calendar deadlines using the given parameters.
|
|
1413
|
-
* @param params - The copy operation parameters.
|
|
1414
|
-
*/
|
|
1415
|
-
copyCalendarDeadlines(params: ClipperCalendarCopyDeadlinesParams): rxjs.Observable<ApiResult<number>>;
|
|
1416
|
-
/**
|
|
1417
|
-
* Marks the given calendar deadline as closed.
|
|
1418
|
-
* @param id - The ID of the deadline to close.
|
|
1419
|
-
*/
|
|
1420
|
-
closeCalendarDeadline(id: string): rxjs.Observable<ApiResult<ClipperDeadlineInfo>>;
|
|
1421
|
-
/**
|
|
1422
|
-
* Creates or updates a calendar deadline.
|
|
1423
|
-
* @param params - The deadline data to save.
|
|
1424
|
-
*/
|
|
1425
|
-
saveCalendarDeadline(params: ClipperCalendarSaveDeadlineParams): rxjs.Observable<ApiResult<ClipperDeadlineInfo[]>>;
|
|
1426
|
-
/**
|
|
1427
|
-
* Retrieves a single calendar deadline by its ID.
|
|
1428
|
-
* @param id - The ID of the deadline to retrieve.
|
|
1429
|
-
*/
|
|
1430
|
-
getCalendarDeadline(id: string): rxjs.Observable<ApiResult<ClipperDeadlineInfo>>;
|
|
1431
|
-
/**
|
|
1432
|
-
* Exports the selected deadlines in iCalendar (.ics) format.
|
|
1433
|
-
* @param ids - The IDs of the deadlines to export.
|
|
1434
|
-
*/
|
|
1435
|
-
exportCalendarDeadlines(ids: string[]): rxjs.Observable<Blob>;
|
|
1436
|
-
/**
|
|
1437
|
-
* Retrieves all archive folders matching the given search parameters.
|
|
1246
|
+
* Retrieves all archive folders matching the given search parameters and stores the
|
|
1247
|
+
* returned teams in the shared state.
|
|
1438
1248
|
* @param params - The folder search parameters.
|
|
1249
|
+
* @returns An observable emitting the API result wrapping the folders search result.
|
|
1439
1250
|
*/
|
|
1440
1251
|
getArchiveFolders(params: ClipperArchiveFoldersSearchParams): rxjs.Observable<ApiResult<ClipperArchiveFoldersSearchResult>>;
|
|
1441
1252
|
/**
|
|
1442
1253
|
* Creates or updates an archive folder.
|
|
1443
1254
|
* @param params - The folder data to save.
|
|
1255
|
+
* @returns An observable emitting the API result wrapping the saved folder.
|
|
1444
1256
|
*/
|
|
1445
1257
|
saveArchiveFolder(params: Folder): rxjs.Observable<ApiResult<Folder>>;
|
|
1446
1258
|
/**
|
|
1447
1259
|
* Exports archive folders as a downloadable file.
|
|
1448
1260
|
* @param id - The folder ID to export, or `undefined` to export all folders.
|
|
1449
1261
|
* @param teamId - The optional team ID. Defaults to `undefined` (personal workspace).
|
|
1262
|
+
* @returns An observable emitting the exported folders content as a blob.
|
|
1450
1263
|
*/
|
|
1451
1264
|
exportArchiveFolders(id?: string, teamId?: string): rxjs.Observable<Blob>;
|
|
1452
1265
|
/**
|
|
1453
1266
|
* Uploads and imports archive folders from a file.
|
|
1454
1267
|
* @param params - The import parameters including the source file and destination folder.
|
|
1268
|
+
* @returns An observable of HTTP events reporting upload progress and the final response.
|
|
1455
1269
|
*/
|
|
1456
1270
|
importArchiveFolders(params: ClipperArchiveFoldersImportParams): rxjs.Observable<_angular_common_http.HttpEvent<unknown>>;
|
|
1457
1271
|
/**
|
|
1458
1272
|
* Retrieves archive files and folders matching the given search parameters.
|
|
1459
1273
|
* @param params - The archive files search parameters.
|
|
1274
|
+
* @returns An observable emitting the API result wrapping the files search result.
|
|
1460
1275
|
*/
|
|
1461
1276
|
queryArchiveItems(params: ClipperArchiveFilesSearchParams): rxjs.Observable<ApiResult<ClipperArchiveFilesSearchResult>>;
|
|
1462
1277
|
/**
|
|
1463
1278
|
* Deletes one or more archive files or folders.
|
|
1464
1279
|
* @param params - The delete operation parameters.
|
|
1280
|
+
* @returns An observable emitting the API result wrapping the number of deleted items.
|
|
1465
1281
|
*/
|
|
1466
1282
|
deleteArchiveItems(params: ClipperArchiveFilesDeleteParams): rxjs.Observable<ApiResult<number>>;
|
|
1467
1283
|
/**
|
|
1468
1284
|
* Copies archive files or folders to a destination folder.
|
|
1469
1285
|
* @param params - The copy operation parameters.
|
|
1286
|
+
* @returns An observable emitting the API result wrapping the number of copied items.
|
|
1470
1287
|
*/
|
|
1471
1288
|
copyArchiveItems(params: ClipperArchiveFilesCopyParams): rxjs.Observable<ApiResult<number>>;
|
|
1472
1289
|
/**
|
|
1473
1290
|
* Uploads and saves an archive file using multipart form data.
|
|
1474
1291
|
* @param params - The file metadata and binary content to save.
|
|
1292
|
+
* @returns An observable of HTTP events reporting upload progress and the final response.
|
|
1475
1293
|
*/
|
|
1476
1294
|
saveArchiveFile(params: ClipperArchiveFileInfo): rxjs.Observable<_angular_common_http.HttpEvent<unknown>>;
|
|
1477
1295
|
/**
|
|
1478
1296
|
* Retrieves the metadata for a single archive file.
|
|
1479
1297
|
* @param id - The ID of the archive file to retrieve.
|
|
1298
|
+
* @returns An observable emitting the API result wrapping the archive file info.
|
|
1480
1299
|
*/
|
|
1481
1300
|
getArchiveFile(id: string): rxjs.Observable<ApiResult<ClipperArchiveFileInfo>>;
|
|
1482
1301
|
/**
|
|
1483
1302
|
* Downloads the binary content of an archive file.
|
|
1484
1303
|
* @param id - The binary ID of the file to download.
|
|
1485
1304
|
* @param otp - An optional one-time password for authenticated downloads.
|
|
1305
|
+
* @returns An observable emitting the file binary content as a blob.
|
|
1486
1306
|
*/
|
|
1487
1307
|
downloadArchiveFile(id: number, otp?: string): rxjs.Observable<Blob>;
|
|
1308
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperArchiveService, never>;
|
|
1309
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperArchiveService>;
|
|
1310
|
+
}
|
|
1311
|
+
|
|
1312
|
+
/**
|
|
1313
|
+
* Calendar deadlines: search, snapshot, save/copy/close/delete and iCalendar export.
|
|
1314
|
+
*/
|
|
1315
|
+
declare class ClipperCalendarService {
|
|
1316
|
+
private readonly httpClient;
|
|
1317
|
+
private readonly core;
|
|
1488
1318
|
/**
|
|
1489
|
-
*
|
|
1490
|
-
* @param params - The
|
|
1491
|
-
|
|
1492
|
-
resetPassword(params: ResetPasswordDialogResult): rxjs.Observable<ApiResult<ResetPasswordDialogResult>>;
|
|
1493
|
-
/**
|
|
1494
|
-
* Initiates a password recovery flow by sending a reset link to the user's email.
|
|
1495
|
-
* @param params - The password recovery request data.
|
|
1319
|
+
* Queries the calendar and stores the returned teams in the shared state.
|
|
1320
|
+
* @param params - The calendar search parameters.
|
|
1321
|
+
* @returns An observable emitting the API result wrapping the calendar search result.
|
|
1496
1322
|
*/
|
|
1497
|
-
|
|
1323
|
+
queryCalendar(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperCalendarSearchResult>>;
|
|
1498
1324
|
/**
|
|
1499
|
-
* Gets the
|
|
1325
|
+
* Gets the calendar snapshot.
|
|
1326
|
+
* @param params - The calendar search parameters.
|
|
1327
|
+
* @returns An observable emitting the API result wrapping the calendar snapshot result.
|
|
1500
1328
|
*/
|
|
1501
|
-
|
|
1329
|
+
calendarSnapshot(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperSearchCalendarSnapshotResult>>;
|
|
1502
1330
|
/**
|
|
1503
|
-
*
|
|
1504
|
-
* @param
|
|
1331
|
+
* Deletes one or more calendar deadlines by ID.
|
|
1332
|
+
* @param ids - The IDs of the deadlines to delete.
|
|
1333
|
+
* @returns An observable emitting the API result wrapping the number of deleted deadlines.
|
|
1505
1334
|
*/
|
|
1506
|
-
|
|
1335
|
+
deleteCalendarDeadlines(ids: string[]): rxjs.Observable<ApiResult<number>>;
|
|
1507
1336
|
/**
|
|
1508
|
-
*
|
|
1509
|
-
* @param params - The
|
|
1337
|
+
* Copies one or more calendar deadlines using the given parameters.
|
|
1338
|
+
* @param params - The copy operation parameters.
|
|
1339
|
+
* @returns An observable emitting the API result wrapping the number of copied deadlines.
|
|
1510
1340
|
*/
|
|
1511
|
-
|
|
1341
|
+
copyCalendarDeadlines(params: ClipperCalendarCopyDeadlinesParams): rxjs.Observable<ApiResult<number>>;
|
|
1512
1342
|
/**
|
|
1513
|
-
*
|
|
1343
|
+
* Marks the given calendar deadline as closed.
|
|
1344
|
+
* @param id - The ID of the deadline to close.
|
|
1345
|
+
* @returns An observable emitting the API result wrapping the updated deadline.
|
|
1514
1346
|
*/
|
|
1515
|
-
|
|
1347
|
+
closeCalendarDeadline(id: string): rxjs.Observable<ApiResult<ClipperDeadlineInfo>>;
|
|
1516
1348
|
/**
|
|
1517
|
-
*
|
|
1349
|
+
* Creates or updates a calendar deadline.
|
|
1350
|
+
* @param params - The deadline data to save.
|
|
1351
|
+
* @returns An observable emitting the API result wrapping the saved deadlines.
|
|
1518
1352
|
*/
|
|
1519
|
-
|
|
1353
|
+
saveCalendarDeadline(params: ClipperCalendarSaveDeadlineParams): rxjs.Observable<ApiResult<ClipperDeadlineInfo[]>>;
|
|
1520
1354
|
/**
|
|
1521
|
-
*
|
|
1522
|
-
* @param
|
|
1355
|
+
* Retrieves a single calendar deadline by its ID.
|
|
1356
|
+
* @param id - The ID of the deadline to retrieve.
|
|
1357
|
+
* @returns An observable emitting the API result wrapping the deadline.
|
|
1523
1358
|
*/
|
|
1524
|
-
|
|
1359
|
+
getCalendarDeadline(id: string): rxjs.Observable<ApiResult<ClipperDeadlineInfo>>;
|
|
1525
1360
|
/**
|
|
1526
|
-
*
|
|
1527
|
-
* @param
|
|
1361
|
+
* Exports the selected deadlines in iCalendar (.ics) format.
|
|
1362
|
+
* @param ids - The IDs of the deadlines to export.
|
|
1363
|
+
* @returns An observable emitting the iCalendar content as a blob.
|
|
1528
1364
|
*/
|
|
1529
|
-
|
|
1365
|
+
exportCalendarDeadlines(ids: string[]): rxjs.Observable<Blob>;
|
|
1366
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperCalendarService, never>;
|
|
1367
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperCalendarService>;
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1370
|
+
/**
|
|
1371
|
+
* Collaboration: teams and team members, contacts and shared document notes.
|
|
1372
|
+
*/
|
|
1373
|
+
declare class ClipperCollaborationService {
|
|
1374
|
+
private readonly httpClient;
|
|
1375
|
+
private readonly core;
|
|
1530
1376
|
/**
|
|
1531
1377
|
* Renames the current user's team.
|
|
1532
1378
|
* @param newName - The new display name for the team.
|
|
1379
|
+
* @returns An observable emitting the API result wrapping the updated team info.
|
|
1533
1380
|
*/
|
|
1534
1381
|
renameTeam(newName: string): rxjs.Observable<ApiResult<ClipperTeamInfo>>;
|
|
1535
1382
|
/**
|
|
1536
|
-
* Retrieves the list of teams available to the current user.
|
|
1383
|
+
* Retrieves the list of teams available to the current user. When not querying
|
|
1384
|
+
* admins only, the result is also stored in the shared teams state.
|
|
1537
1385
|
* @param params - The teams search parameters.
|
|
1386
|
+
* @returns An observable emitting the API result wrapping the teams search result.
|
|
1538
1387
|
*/
|
|
1539
1388
|
getTeams(params: ClipperTeamsSearchParams): rxjs.Observable<ApiResult<ClipperTeamsSearchResult>>;
|
|
1540
1389
|
/**
|
|
1541
1390
|
* Retrieves the members of a team matching the given search parameters.
|
|
1542
1391
|
* @param params - The team members search parameters.
|
|
1392
|
+
* @returns An observable emitting the API result wrapping the team members search result.
|
|
1543
1393
|
*/
|
|
1544
1394
|
getTeamMembers(params: ClipperTeamsSearchParams): rxjs.Observable<ApiResult<ClipperTeamMembersSearchResult>>;
|
|
1545
1395
|
/**
|
|
1546
1396
|
* Removes the specified members from the team.
|
|
1547
1397
|
* @param teamId - The ID of the team.
|
|
1548
1398
|
* @param ids - The numeric IDs of the team members to remove.
|
|
1399
|
+
* @returns An observable emitting the API result wrapping the number of removed members.
|
|
1549
1400
|
*/
|
|
1550
1401
|
deleteTeamMembers(teamId: string, ids: number[]): rxjs.Observable<ApiResult<number>>;
|
|
1551
1402
|
/**
|
|
1552
1403
|
* Creates or updates a team member record.
|
|
1553
1404
|
* @param item - The team member data to save.
|
|
1405
|
+
* @returns An observable emitting the API result wrapping the saved team member.
|
|
1554
1406
|
*/
|
|
1555
1407
|
saveTeamMember(item: ClipperTeamMemberInfo): rxjs.Observable<ApiResult<ClipperTeamMemberInfo>>;
|
|
1556
1408
|
/**
|
|
1557
1409
|
* Retrieves contacts matching the given search parameters.
|
|
1558
1410
|
* @param params - The contacts search parameters.
|
|
1411
|
+
* @returns An observable emitting the API result wrapping the contacts query result.
|
|
1559
1412
|
*/
|
|
1560
1413
|
queryContacts(params: ClipperContactsSearchParams): rxjs.Observable<ApiResult<QueryResultModel<ClipperContactInfo>>>;
|
|
1561
1414
|
/**
|
|
1562
1415
|
* Deletes the specified contacts.
|
|
1563
1416
|
* @param ids - The numeric IDs of the contacts to remove.
|
|
1417
|
+
* @returns An observable emitting the API result wrapping the number of deleted contacts.
|
|
1564
1418
|
*/
|
|
1565
1419
|
deleteContacts(ids: number[]): rxjs.Observable<ApiResult<number>>;
|
|
1566
1420
|
/**
|
|
1567
1421
|
* Creates or updates a contact record.
|
|
1568
1422
|
* @param item - The contact data to save.
|
|
1423
|
+
* @returns An observable emitting the API result wrapping the saved contact.
|
|
1569
1424
|
*/
|
|
1570
1425
|
saveContact(item: ClipperContactInfo): rxjs.Observable<ApiResult<ClipperContactInfo>>;
|
|
1571
1426
|
/**
|
|
1572
|
-
* Retrieves document notes matching the given search parameters
|
|
1427
|
+
* Retrieves document notes matching the given search parameters and stores the
|
|
1428
|
+
* returned teams in the shared state.
|
|
1573
1429
|
* @param params - The notes search parameters.
|
|
1430
|
+
* @returns An observable emitting the API result wrapping the notes search result.
|
|
1574
1431
|
*/
|
|
1575
1432
|
queryNotes(params: ClipperNotesSearchParams): rxjs.Observable<ApiResult<ClipperNotesSearchResult>>;
|
|
1576
1433
|
/**
|
|
1577
1434
|
* Deletes the specified document notes.
|
|
1578
1435
|
* @param ids - The numeric IDs of the notes to remove.
|
|
1436
|
+
* @returns An observable emitting the API result wrapping the number of deleted notes.
|
|
1579
1437
|
*/
|
|
1580
1438
|
deleteNotes(ids: number[]): rxjs.Observable<ApiResult<number>>;
|
|
1581
1439
|
/**
|
|
1582
1440
|
* Creates or updates a document note.
|
|
1583
1441
|
* @param item - The note data to save.
|
|
1442
|
+
* @returns An observable emitting the API result wrapping the saved note.
|
|
1584
1443
|
*/
|
|
1585
1444
|
saveNote(item: ClipperDocumentNote): rxjs.Observable<ApiResult<ClipperDocumentNote>>;
|
|
1586
1445
|
/**
|
|
1587
1446
|
* Retrieves the tracking history for the given document note.
|
|
1588
1447
|
* @param id - The numeric ID of the note whose tracking records to retrieve.
|
|
1448
|
+
* @returns An observable emitting the API result wrapping the note tracking records.
|
|
1589
1449
|
*/
|
|
1590
1450
|
getNoteTrackings(id: number): rxjs.Observable<ApiResult<ClipperDocumentNoteTracking[]>>;
|
|
1591
1451
|
/**
|
|
1592
1452
|
* Gets the count of troubled tracking notifications for document notes,
|
|
1593
1453
|
* which can be used to display an unread counter in the UI.
|
|
1454
|
+
* @returns An observable emitting the API result wrapping the troubled tracking count.
|
|
1594
1455
|
*/
|
|
1595
1456
|
countNotesTrackingsTroubled(): rxjs.Observable<ApiResult<number>>;
|
|
1596
|
-
static ɵfac:
|
|
1597
|
-
static ɵprov:
|
|
1457
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperCollaborationService, never>;
|
|
1458
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperCollaborationService>;
|
|
1459
|
+
}
|
|
1460
|
+
|
|
1461
|
+
/**
|
|
1462
|
+
* Document search, references, export and metadata, plus the dashboard counters,
|
|
1463
|
+
* taxonomy/topics/tags lookups, the working-documents "bag" and saved searches.
|
|
1464
|
+
*/
|
|
1465
|
+
declare class ClipperDocumentsService {
|
|
1466
|
+
private readonly httpClient;
|
|
1467
|
+
private readonly broadcastService;
|
|
1468
|
+
private readonly core;
|
|
1469
|
+
/**
|
|
1470
|
+
* Queries documents matching the given search parameters.
|
|
1471
|
+
* @param params - The document search parameters.
|
|
1472
|
+
* @returns An observable emitting the API result wrapping the search result.
|
|
1473
|
+
*/
|
|
1474
|
+
query(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperSearchResult>>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Retrieves the facets for a document query.
|
|
1477
|
+
* @param params - The document search parameters.
|
|
1478
|
+
* @returns An observable emitting the API result wrapping the search facets.
|
|
1479
|
+
*/
|
|
1480
|
+
queryFacets(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperSearchFacetsResult>>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Updates the state of one or more documents.
|
|
1483
|
+
* @param params - The document state update parameters.
|
|
1484
|
+
* @returns An observable emitting the API result wrapping the number of updated documents.
|
|
1485
|
+
*/
|
|
1486
|
+
updateState(params: ClipperDocumentUpdateStateParams): rxjs.Observable<ApiResult<number>>;
|
|
1487
|
+
/**
|
|
1488
|
+
* Exports a single document in PDF format.
|
|
1489
|
+
* @param id - The ID of the document to export.
|
|
1490
|
+
* @returns An observable emitting the PDF binary content as a blob.
|
|
1491
|
+
*/
|
|
1492
|
+
exportPdf(id: string): rxjs.Observable<Blob>;
|
|
1493
|
+
/**
|
|
1494
|
+
* Exports a document list (query or selected items), or exports deadlines as ICS.
|
|
1495
|
+
* @param params - The export parameters.
|
|
1496
|
+
* @returns An observable emitting the exported content as a blob.
|
|
1497
|
+
*/
|
|
1498
|
+
export(params: ClipperExportDocumentsParams): rxjs.Observable<Blob>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Sends document links by email.
|
|
1501
|
+
* @param params - The send-by-email parameters including recipients and documents.
|
|
1502
|
+
* @returns An observable emitting the API result wrapping the number of sent items.
|
|
1503
|
+
*/
|
|
1504
|
+
sendTo(params: ClipperSendDocumentsByEmailParams): rxjs.Observable<ApiResult<number>>;
|
|
1505
|
+
/**
|
|
1506
|
+
* Sends an email notification about a document note update to the specified recipients.
|
|
1507
|
+
* @param params - The notification parameters including recipients and note details.
|
|
1508
|
+
* @returns An observable emitting the API result wrapping the note tracking update.
|
|
1509
|
+
*/
|
|
1510
|
+
notifyNoteTo(params: ClipperNotifyDocumentNoteParams): rxjs.Observable<ApiResult<UpdateResultModel<ClipperDocumentNoteTracking>>>;
|
|
1511
|
+
/**
|
|
1512
|
+
* Retrieves the full document report page.
|
|
1513
|
+
* @param id - The ID of the document.
|
|
1514
|
+
* @returns An observable emitting the report content as a blob.
|
|
1515
|
+
*/
|
|
1516
|
+
report(id: string): rxjs.Observable<Blob>;
|
|
1517
|
+
/**
|
|
1518
|
+
* Gets the comment associated with a document.
|
|
1519
|
+
* @param id - The ID of the document.
|
|
1520
|
+
* @returns An observable emitting the API result wrapping the comment text.
|
|
1521
|
+
*/
|
|
1522
|
+
comment(id: string): rxjs.Observable<ApiResult<string>>;
|
|
1523
|
+
/**
|
|
1524
|
+
* Gets the info for a document.
|
|
1525
|
+
* @param id - The ID of the document.
|
|
1526
|
+
* @returns An observable emitting the API result wrapping the document info.
|
|
1527
|
+
*/
|
|
1528
|
+
info(id: string): rxjs.Observable<ApiResult<ClipperDocumentInfo>>;
|
|
1529
|
+
/**
|
|
1530
|
+
* Gets the structure (index) of a document.
|
|
1531
|
+
* @param id - The ID of the document.
|
|
1532
|
+
* @returns An observable emitting the API result wrapping the document structure.
|
|
1533
|
+
*/
|
|
1534
|
+
index(id: string): rxjs.Observable<ApiResult<ClipperDocumentStructure>>;
|
|
1535
|
+
/**
|
|
1536
|
+
* Gets the last-update metadata for a document.
|
|
1537
|
+
* @param id - The ID of the document.
|
|
1538
|
+
* @returns An observable emitting the API result wrapping the last update string and its notes.
|
|
1539
|
+
*/
|
|
1540
|
+
metadata(id: string): rxjs.Observable<ApiResult<{
|
|
1541
|
+
item1?: string;
|
|
1542
|
+
item2?: ClipperDocumentNote[];
|
|
1543
|
+
}>>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Queries document references, changes or jurisprudence depending on the requested mode.
|
|
1546
|
+
* @param params - The references search parameters; `mode` defaults to `ReferencesIn`.
|
|
1547
|
+
* @returns An observable emitting the API result wrapping the search result, or `null` for an unsupported mode.
|
|
1548
|
+
*/
|
|
1549
|
+
references(params: ClipperReferencesSearchParams): rxjs.Observable<ApiResult<ClipperSearchResult>>;
|
|
1550
|
+
/**
|
|
1551
|
+
* Retrieves the facets for a document references query.
|
|
1552
|
+
* @param params - The references search parameters; `mode` defaults to `ReferencesIn`.
|
|
1553
|
+
* @returns An observable emitting the API result wrapping the search facets, or `null` for an unsupported mode.
|
|
1554
|
+
*/
|
|
1555
|
+
referencesFacets(params: ClipperReferencesSearchParams): rxjs.Observable<ApiResult<ClipperSearchFacetsResult>>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Wraps document rendering to allow token refresh.
|
|
1558
|
+
* @returns An observable emitting the API result wrapping a boolean readiness flag.
|
|
1559
|
+
*/
|
|
1560
|
+
preRender(): rxjs.Observable<ApiResult<boolean>>;
|
|
1561
|
+
/**
|
|
1562
|
+
* Gets the jurisprudence articles for a document query.
|
|
1563
|
+
* @param params - The document search parameters.
|
|
1564
|
+
* @returns An observable emitting the API result wrapping the search result.
|
|
1565
|
+
*/
|
|
1566
|
+
jurisArticles(params: ClipperSearchParams): rxjs.Observable<ApiResult<ClipperSearchResult>>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Gets a deadlines snapshot based on the supplied deadlines.
|
|
1569
|
+
* @param params - The calendar search parameters.
|
|
1570
|
+
* @returns An observable emitting the API result wrapping the calendar snapshot result.
|
|
1571
|
+
*/
|
|
1572
|
+
deadlinesSnapshot(params: ClipperCalendarSearchParams): rxjs.Observable<ApiResult<ClipperSearchCalendarSnapshotResult>>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Retrieves the taxonomy.
|
|
1575
|
+
* @param params - Optional taxonomy parameters. Defaults to `{ model: 0, countItems: false }`.
|
|
1576
|
+
* @returns An observable emitting the API result wrapping the taxonomy folder tree.
|
|
1577
|
+
*/
|
|
1578
|
+
getTaxonomy(params?: ClipperTaxonomyParams): rxjs.Observable<ApiResult<FolderTree>>;
|
|
1579
|
+
/**
|
|
1580
|
+
* Retrieves the topics as a flat list.
|
|
1581
|
+
* @returns An observable emitting the API result wrapping the list of topics.
|
|
1582
|
+
*/
|
|
1583
|
+
getTopics(): rxjs.Observable<ApiResult<NameValueItem<string>[]>>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Retrieves the topics as a tree.
|
|
1586
|
+
* @returns An observable emitting the API result wrapping the topics folder tree.
|
|
1587
|
+
*/
|
|
1588
|
+
getTopicsAsTree(): rxjs.Observable<ApiResult<FolderTree>>;
|
|
1589
|
+
/**
|
|
1590
|
+
* Retrieves the tags.
|
|
1591
|
+
* @returns An observable emitting the API result wrapping the list of tags.
|
|
1592
|
+
*/
|
|
1593
|
+
getTags(): rxjs.Observable<ApiResult<NameValueItem<string>[]>>;
|
|
1594
|
+
/**
|
|
1595
|
+
* Loads the working documents and populates the shared bag.
|
|
1596
|
+
* @returns The subscription to the working-documents request.
|
|
1597
|
+
*/
|
|
1598
|
+
loadBag(): rxjs.Subscription;
|
|
1599
|
+
/**
|
|
1600
|
+
* Adds one or more documents to the working documents bag.
|
|
1601
|
+
* @param documentIds - The IDs of the documents to add.
|
|
1602
|
+
* @returns The subscription to the add-to-bag request.
|
|
1603
|
+
*/
|
|
1604
|
+
addToBag(documentIds: string[]): rxjs.Subscription;
|
|
1605
|
+
/**
|
|
1606
|
+
* Removes a document from the working documents bag.
|
|
1607
|
+
* @param documentId - The ID of the document to remove.
|
|
1608
|
+
* @returns The subscription to the remove-from-bag request.
|
|
1609
|
+
*/
|
|
1610
|
+
removeFromBag(documentId: string): rxjs.Subscription;
|
|
1611
|
+
/**
|
|
1612
|
+
* Clears all working documents from the bag.
|
|
1613
|
+
* @returns The subscription to the clear-bag request.
|
|
1614
|
+
*/
|
|
1615
|
+
clearBag(): rxjs.Subscription;
|
|
1616
|
+
/**
|
|
1617
|
+
* Retrieves the saved searches for the given module.
|
|
1618
|
+
* @param module - The Clipper module whose saved searches to load.
|
|
1619
|
+
* @returns An observable emitting the API result wrapping the list of saved searches.
|
|
1620
|
+
*/
|
|
1621
|
+
loadSearches(module: ClipperModule): rxjs.Observable<ApiResult<ClipperUserSearch[]>>;
|
|
1622
|
+
/**
|
|
1623
|
+
* Persists a user search configuration on the server.
|
|
1624
|
+
* @param params - The search configuration to save.
|
|
1625
|
+
* @returns An observable emitting the API result wrapping the saved search.
|
|
1626
|
+
*/
|
|
1627
|
+
saveSearch(params: ClipperUserSearch): rxjs.Observable<ApiResult<ClipperUserSearch>>;
|
|
1628
|
+
/**
|
|
1629
|
+
* Deletes a saved search by its ID.
|
|
1630
|
+
* @param id - The ID of the saved search to remove.
|
|
1631
|
+
* @returns An observable emitting the API result wrapping the number of deleted searches.
|
|
1632
|
+
*/
|
|
1633
|
+
deleteSearch(id: number): rxjs.Observable<ApiResult<number>>;
|
|
1634
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperDocumentsService, never>;
|
|
1635
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperDocumentsService>;
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
/**
|
|
1639
|
+
* Authentication: credential / OAuth2 login, MFA confirmation, logout and OTP.
|
|
1640
|
+
* Shared login context, channels and the logged-in flag live in `ClipperCoreService`.
|
|
1641
|
+
*/
|
|
1642
|
+
declare class ClipperLoginService {
|
|
1643
|
+
private readonly httpClient;
|
|
1644
|
+
private readonly broadcastService;
|
|
1645
|
+
private readonly splashService;
|
|
1646
|
+
private readonly core;
|
|
1647
|
+
/**
|
|
1648
|
+
* Attempts an automatic login using the credentials currently stored in session storage.
|
|
1649
|
+
* @param onSuccess - Optional callback invoked with the login result value on success.
|
|
1650
|
+
*/
|
|
1651
|
+
autoLogin(onSuccess?: (value?: any) => void): void;
|
|
1652
|
+
/**
|
|
1653
|
+
* Performs an automatic logout and clears the stored session.
|
|
1654
|
+
* @param onSuccess - Optional callback invoked after a successful logout.
|
|
1655
|
+
*/
|
|
1656
|
+
autoLogout(onSuccess?: () => void): void;
|
|
1657
|
+
/**
|
|
1658
|
+
* Authenticates the user against the Clipper API, supporting both credential-based and
|
|
1659
|
+
* OAuth2 login flows.
|
|
1660
|
+
* @param email - The user's email address (credential login only).
|
|
1661
|
+
* @param password - The user's password (credential login only).
|
|
1662
|
+
* @param remember - When `true`, the session is remembered across browser restarts.
|
|
1663
|
+
* @param oauth - The OAuth2 provider type, when authenticating via SSO.
|
|
1664
|
+
* @param oauthAccessToken - The OAuth2 bearer token. Defaults to the value stored in session storage.
|
|
1665
|
+
* @returns An observable emitting the API result wrapping the login result.
|
|
1666
|
+
*/
|
|
1667
|
+
login(email?: string, password?: string, remember?: boolean, oauth?: LoginOAuthType, oauthAccessToken?: string | undefined): rxjs.Observable<ApiResult<ClipperLoginResult>>;
|
|
1668
|
+
/**
|
|
1669
|
+
* Finalises the login flow by updating the stored context, setting the logged-in signal,
|
|
1670
|
+
* initialising channels, and broadcasting `LOGIN_COMPLETED`.
|
|
1671
|
+
* @param result - The login result returned by the API.
|
|
1672
|
+
*/
|
|
1673
|
+
private completeLogin;
|
|
1674
|
+
/**
|
|
1675
|
+
* Submits the MFA confirmation code to complete a two-factor login flow.
|
|
1676
|
+
* @param code - The one-time confirmation code provided to the user.
|
|
1677
|
+
* @returns An observable emitting the API result wrapping the login result.
|
|
1678
|
+
*/
|
|
1679
|
+
confirmIdentity(code: string): rxjs.Observable<ApiResult<ClipperLoginResult>>;
|
|
1680
|
+
/**
|
|
1681
|
+
* Logs the user out and clears the current session.
|
|
1682
|
+
* @param forget - When `true`, all stored user credentials are also removed.
|
|
1683
|
+
* @returns An observable that completes once the logout request has been processed.
|
|
1684
|
+
*/
|
|
1685
|
+
logout(forget?: boolean): rxjs.Observable<any>;
|
|
1686
|
+
/**
|
|
1687
|
+
* Requests a new one-time password for the given repository.
|
|
1688
|
+
* @param id - The repository ID for which the OTP should be generated.
|
|
1689
|
+
* @returns An observable emitting the API result wrapping the generated OTP info.
|
|
1690
|
+
*/
|
|
1691
|
+
newOTP(id: string): rxjs.Observable<ApiResult<ClipperOTPInfo>>;
|
|
1692
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperLoginService, never>;
|
|
1693
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperLoginService>;
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
/**
|
|
1697
|
+
* Barrel / facade for the Clipper application.
|
|
1698
|
+
*
|
|
1699
|
+
* Exposes the feature services as named properties and re-exports the shared state
|
|
1700
|
+
* declared in `ClipperCoreService`. Inject `ClipperService` and reach a feature via
|
|
1701
|
+
* its property, e.g. `clipper.login.login(...)`, `clipper.documents.query(...)`,
|
|
1702
|
+
* `clipper.calendar.queryCalendar(...)`.
|
|
1703
|
+
*/
|
|
1704
|
+
declare class ClipperService {
|
|
1705
|
+
private readonly core;
|
|
1706
|
+
/** Authentication: login/logout, MFA, OTP. */
|
|
1707
|
+
readonly session: ClipperLoginService;
|
|
1708
|
+
/** Document search, references, export, working-documents bag and saved searches. */
|
|
1709
|
+
readonly documents: ClipperDocumentsService;
|
|
1710
|
+
/** Account settings, dashboard, password, channels, trial info and user links. */
|
|
1711
|
+
readonly account: ClipperAccountService;
|
|
1712
|
+
/** Archive folders and files. */
|
|
1713
|
+
readonly archive: ClipperArchiveService;
|
|
1714
|
+
/** Calendar deadlines. */
|
|
1715
|
+
readonly calendar: ClipperCalendarService;
|
|
1716
|
+
/** Teams, contacts and shared notes. */
|
|
1717
|
+
readonly collaboration: ClipperCollaborationService;
|
|
1718
|
+
/** @returns The URI of the Clipper web application, or `undefined` if not set. */
|
|
1719
|
+
get appUri(): string | undefined;
|
|
1720
|
+
/** @returns The base URI of the Clipper REST API. */
|
|
1721
|
+
get serviceUri(): string;
|
|
1722
|
+
/** @returns The active feature flags. */
|
|
1723
|
+
get flags(): ClipperServiceFlags;
|
|
1724
|
+
/** @returns The current login context, or `undefined` if not authenticated. */
|
|
1725
|
+
get loginInfo(): ClipperLoginInfo | undefined;
|
|
1726
|
+
/** @returns A read-only signal indicating whether the user is logged in. */
|
|
1727
|
+
get loggedIn(): Signal<boolean>;
|
|
1728
|
+
/** @returns A signal indicating whether a login is in progress. */
|
|
1729
|
+
get loggingIn(): WritableSignal<boolean>;
|
|
1730
|
+
/** @returns A signal holding the current documents search snapshot. */
|
|
1731
|
+
get snapshot(): WritableSignal<ClipperSearchResult | undefined>;
|
|
1732
|
+
/** @returns A signal indicating whether reference search is supported. */
|
|
1733
|
+
get supportsRS(): WritableSignal<boolean>;
|
|
1734
|
+
/** @returns A signal holding the current references search snapshot. */
|
|
1735
|
+
get referencesSnapshot(): WritableSignal<ClipperSearchResult | undefined>;
|
|
1736
|
+
/** @returns The shared dashboard state object. */
|
|
1737
|
+
get dashboard(): ClipperDashboard;
|
|
1738
|
+
/** @returns A signal holding the working-documents bag. */
|
|
1739
|
+
get bag(): WritableSignal<ClipperDocumentInfo[]>;
|
|
1740
|
+
/** @returns A computed signal with the number of items in the bag. */
|
|
1741
|
+
get bagTotal(): Signal<number>;
|
|
1742
|
+
/** @returns A signal controlling the Clipper UI visibility. */
|
|
1743
|
+
get visible(): WritableSignal<boolean>;
|
|
1744
|
+
/** @returns The shared teams collection. */
|
|
1745
|
+
get teams(): NameValueItem<string>[];
|
|
1746
|
+
/** @returns A signal holding the available channels. */
|
|
1747
|
+
get availableChannels(): WritableSignal<ClipperAvailableChannel[]>;
|
|
1748
|
+
/** @returns A computed signal with the currently active channels. */
|
|
1749
|
+
get activeChannels(): Signal<ClipperAvailableChannel[]>;
|
|
1750
|
+
/** @returns A signal indicating whether tagging is allowed. */
|
|
1751
|
+
get allowTags(): WritableSignal<boolean>;
|
|
1752
|
+
/** @returns A signal with the number of pending notes, or `undefined` if unknown. */
|
|
1753
|
+
get pendingNotes(): WritableSignal<number | undefined>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Initialises the application with the API base URI, optional app URI, and feature flags.
|
|
1756
|
+
* @param serviceUri - The base URI of the Clipper REST API.
|
|
1757
|
+
* @param appUri - Optional URI of the Clipper web application (used to build document links).
|
|
1758
|
+
* @param flags - Feature flags that control service behaviour. Defaults to `ClipperServiceFlags.None`.
|
|
1759
|
+
*/
|
|
1760
|
+
initialize(serviceUri: string, appUri?: string, flags?: ClipperServiceFlags): void;
|
|
1761
|
+
/**
|
|
1762
|
+
* Pings the Clipper REST API to keep the session/token alive.
|
|
1763
|
+
*/
|
|
1764
|
+
ping(): void;
|
|
1765
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClipperService, never>;
|
|
1766
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ClipperService>;
|
|
1598
1767
|
}
|
|
1599
1768
|
|
|
1600
|
-
export { ClipperArchiveCopyMode, ClipperArchiveFileStorageType, ClipperArchiveFileStorageTypes, ClipperArchiveFileType, ClipperArchiveFileTypes, ClipperArchiveFilesSearchParams, ClipperArchiveFoldersSearchParams, ClipperAuthInterceptor, ClipperAuthors, ClipperCalendarCopyMode, ClipperCalendarSearchParams, ClipperCalendarState, ClipperCalendarStates, ClipperChannel, ClipperChannelSettings, ClipperChannels, ClipperDashboard, ClipperDocumentChangeReasons, ClipperDocumentContainer, ClipperExportDocumentsFormat, ClipperFacet, ClipperMessages, ClipperModel, ClipperModels, ClipperModule, ClipperModuleGroup, ClipperModuleGroups, ClipperModules, ClipperQueryDocumentFlags, ClipperQueryReferencesMode, ClipperRecurrenceType, ClipperRecurrenceTypes, ClipperRegions, ClipperSearchCalendarSnapshotResult, ClipperSearchFacetsSnapshot, ClipperSearchParams, ClipperSearchResult, ClipperSearchUtils, ClipperSectorTypes, ClipperSectors, ClipperSelectionMode, ClipperService, ClipperServiceFlags, ClipperSort, ClipperSources, ClipperTeamInfo, ClipperTeamProduct, ClipperTeamProductPermission, ClipperUpdateChannelsStateParams, ClipperUtils, NotesColors };
|
|
1769
|
+
export { ClipperAccountService, ClipperArchiveCopyMode, ClipperArchiveFileStorageType, ClipperArchiveFileStorageTypes, ClipperArchiveFileType, ClipperArchiveFileTypes, ClipperArchiveFilesSearchParams, ClipperArchiveFoldersSearchParams, ClipperArchiveService, ClipperAuthInterceptor, ClipperAuthors, ClipperCalendarCopyMode, ClipperCalendarSearchParams, ClipperCalendarService, ClipperCalendarState, ClipperCalendarStates, ClipperChannel, ClipperChannelSettings, ClipperChannels, ClipperCollaborationService, ClipperDashboard, ClipperDocumentChangeReasons, ClipperDocumentContainer, ClipperDocumentsService, ClipperExportDocumentsFormat, ClipperFacet, ClipperLoginService, ClipperMessages, ClipperModel, ClipperModels, ClipperModule, ClipperModuleGroup, ClipperModuleGroups, ClipperModules, ClipperQueryDocumentFlags, ClipperQueryReferencesMode, ClipperRecurrenceType, ClipperRecurrenceTypes, ClipperRegions, ClipperSearchCalendarSnapshotResult, ClipperSearchFacetsSnapshot, ClipperSearchParams, ClipperSearchResult, ClipperSearchUtils, ClipperSectorTypes, ClipperSectors, ClipperSelectionMode, ClipperService, ClipperServiceFlags, ClipperSort, ClipperSources, ClipperTeamInfo, ClipperTeamProduct, ClipperTeamProductPermission, ClipperUpdateChannelsStateParams, ClipperUtils, NotesColors };
|
|
1601
1770
|
export type { ClipperArchiveFileInfo, ClipperArchiveFilesCopyParams, ClipperArchiveFilesDeleteParams, ClipperArchiveFilesSearchResult, ClipperArchiveFolderTree, ClipperArchiveFoldersImportParams, ClipperArchiveFoldersSearchResult, ClipperArsEventInfo, ClipperAvailableChannel, ClipperCalendarCopyDeadlinesParams, ClipperCalendarSaveDeadlineParams, ClipperCalendarSearchResult, ClipperChannelSettingsItem, ClipperContactInfo, ClipperContactsSearchParams, ClipperDashboardItem, ClipperDashboardModelItem, ClipperDashboardResult, ClipperDayGroup, ClipperDayItem, ClipperDeadlineInfo, ClipperDeleteWorkingDocumentsParams, ClipperDocumentAnchorInfo, ClipperDocumentInfo, ClipperDocumentNote, ClipperDocumentNoteTracking, ClipperDocumentRelevantChunkHit, ClipperDocumentRelevants, ClipperDocumentStructure, ClipperDocumentUpdateStateParams, ClipperExportDocumentsParams, ClipperLastDaysResult, ClipperLoginInfo, ClipperLoginResult, ClipperNotesSearchParams, ClipperNotesSearchResult, ClipperNotifyDocumentNoteParams, ClipperOTPInfo, ClipperReferencesSearchParams, ClipperSearchArsEventsParams, ClipperSearchArsEventsResult, ClipperSearchCalendarSnapshotMonth, ClipperSearchFacet, ClipperSearchFacetGroup, ClipperSearchFacetsResult, ClipperSearchFilter, ClipperSendDocumentsByEmailParams, ClipperSettingsInfo, ClipperTaxonomyParams, ClipperTeamMemberInfo, ClipperTeamMembersSearchResult, ClipperTeamProductInfo, ClipperTeamsSearchParams, ClipperTeamsSearchResult, ClipperTopicInfo, ClipperUserChannelInfo, ClipperUserInfo, ClipperUserLink, ClipperUserSearch, ClipperUserTrialInfo, ClipperUserWorkingDocument, EditDialogCompleted, EditDialogData, EditedEventArgs, SectorInfo };
|