@sinequa/atomic 2.6.0 → 2.7.0
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/dist/atomic.cjs +1 -1
- package/dist/atomic.js +2 -2
- package/dist/client/create-api.d.ts +4 -1
- package/dist/client/create-api.d.ts.map +1 -1
- package/dist/spfx/index.cjs +1 -1
- package/dist/spfx/index.js +2 -2
- package/dist/{src-C_FBvs_m.cjs → src-BS1kfBgv.cjs} +1 -1
- package/dist/{src-DWffZxoZ.js → src-BowomHL9.js} +164 -134
- package/dist/types/api-endpoints.d.ts +1 -1
- package/dist/types/api-endpoints.d.ts.map +1 -1
- package/dist/types/document-upload/index.d.ts +1 -0
- package/dist/types/document-upload/index.d.ts.map +1 -1
- package/dist/types/document-upload/upload-status.d.ts +56 -0
- package/dist/types/document-upload/upload-status.d.ts.map +1 -0
- package/dist/types/security-principal/security-principal.d.ts +6 -0
- package/dist/types/security-principal/security-principal.d.ts.map +1 -1
- package/dist/web-api/index.d.ts +1 -0
- package/dist/web-api/index.d.ts.map +1 -1
- package/dist/web-api/v1/fetch-security-principal.d.ts +18 -2
- package/dist/web-api/v1/fetch-security-principal.d.ts.map +1 -1
- package/dist/web-api/v2/fetch-document-upload-container.d.ts +17 -2
- package/dist/web-api/v2/fetch-document-upload-container.d.ts.map +1 -1
- package/dist/web-api/v2/fetch-document-upload-status.d.ts +23 -0
- package/dist/web-api/v2/fetch-document-upload-status.d.ts.map +1 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
type StringWithAutocomplete<T> = T | (string & Record<never, never>);
|
|
2
|
-
export type API_ENDPOINTS = StringWithAutocomplete<"api/v1/app" | "api/v1/audit.notify" | "api/v1/challenge" | "api/v1/doc.textchunks" | "api/v1/labels" | "api/v1/multi" | "api/v1/OriginalDocMerge" | "api/v1/plugin" | "api/v1/preview" | "api/v1/principal" | "api/v1/principal/list" | "api/v1/principal/userids" | "api/v1/query" | "api/v1/query.export" | "api/v1/query.links" | "api/v1/queryintent" | "api/v1/ratings" | "api/v1/recentqueries" | "api/v1/search.dataset" | "api/v1/search.rfm" | "api/v1/search.suggest" | "api/v1/search.queryexport" | "api/v1/similardocuments" | "api/v1/suggestfield" | "api/v1/suggestquery" | "api/v1/usersettings" | "api/v1/security.webtoken" | "api/v1/security.oauth" | "api/v1/security.saml" | "api/v1/security.principal" | "api/v2/document-upload/container" | "api/v2/document-upload/containers">;
|
|
2
|
+
export type API_ENDPOINTS = StringWithAutocomplete<"api/v1/app" | "api/v1/audit.notify" | "api/v1/challenge" | "api/v1/doc.textchunks" | "api/v1/labels" | "api/v1/multi" | "api/v1/OriginalDocMerge" | "api/v1/plugin" | "api/v1/preview" | "api/v1/principal" | "api/v1/principal/list" | "api/v1/principal/userids" | "api/v1/query" | "api/v1/query.export" | "api/v1/query.links" | "api/v1/queryintent" | "api/v1/ratings" | "api/v1/recentqueries" | "api/v1/search.dataset" | "api/v1/search.rfm" | "api/v1/search.suggest" | "api/v1/search.queryexport" | "api/v1/similardocuments" | "api/v1/suggestfield" | "api/v1/suggestquery" | "api/v1/usersettings" | "api/v1/security.webtoken" | "api/v1/security.oauth" | "api/v1/security.saml" | "api/v1/security.principal" | "api/v2/document-upload/container" | "api/v2/document-upload/containers" | "api/v2/document-upload/status">;
|
|
3
3
|
export {};
|
|
4
4
|
//# sourceMappingURL=api-endpoints.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/types/api-endpoints.ts"],"names":[],"mappings":"AAAA,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AACrE,MAAM,MAAM,aAAa,GAAG,sBAAsB,CAC9C,YAAY,GACZ,qBAAqB,GACrB,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,cAAc,GACd,yBAAyB,GACzB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,cAAc,GACd,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,gBAAgB,GAChB,sBAAsB,GACtB,uBAAuB,GACvB,mBAAmB,GACnB,uBAAuB,GACvB,2BAA2B,GAC3B,yBAAyB,GACzB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,kCAAkC,GAClC,mCAAmC,
|
|
1
|
+
{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/types/api-endpoints.ts"],"names":[],"mappings":"AAAA,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AACrE,MAAM,MAAM,aAAa,GAAG,sBAAsB,CAC9C,YAAY,GACZ,qBAAqB,GACrB,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,cAAc,GACd,yBAAyB,GACzB,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,cAAc,GACd,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,gBAAgB,GAChB,sBAAsB,GACtB,uBAAuB,GACvB,mBAAmB,GACnB,uBAAuB,GACvB,2BAA2B,GAC3B,yBAAyB,GACzB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,kCAAkC,GAClC,mCAAmC,GACnC,+BAA+B,CAClC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/document-upload/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/document-upload/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/** Upload-phase status of a job. */
|
|
2
|
+
export type JobUploadStatus = "uploading" | "upload_complete" | "upload_interrupted";
|
|
3
|
+
/** Indexing-phase status of a job. */
|
|
4
|
+
export type JobIndexingStatus = "pending" | "indexing" | "complete" | "failed" | "interrupted";
|
|
5
|
+
/** Aggregate progress over a job's files. */
|
|
6
|
+
export interface UploadJobProgress {
|
|
7
|
+
percentage: number;
|
|
8
|
+
}
|
|
9
|
+
/** A per-file error recorded against a job. */
|
|
10
|
+
export interface UploadJobError {
|
|
11
|
+
fileName: string;
|
|
12
|
+
error?: string | null;
|
|
13
|
+
errorCode?: string | null;
|
|
14
|
+
timestamp?: string | null;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* A file the server will never index (type outside the collection's conversion
|
|
18
|
+
* plan). Terminal and silent: nothing else in the response marks it, so without
|
|
19
|
+
* surfacing this the file is indistinguishable from one still in flight.
|
|
20
|
+
*/
|
|
21
|
+
export interface UploadJobRejection {
|
|
22
|
+
fileName: string;
|
|
23
|
+
path: string;
|
|
24
|
+
reason: string;
|
|
25
|
+
timestamp?: string;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* An upload/indexing job. The endpoint reports jobs, never documents: the only
|
|
29
|
+
* per-file data are `errors` and `rejected`, both keyed by file name.
|
|
30
|
+
*/
|
|
31
|
+
export interface UploadJobStatus {
|
|
32
|
+
jobId: string;
|
|
33
|
+
uploadStatus: JobUploadStatus;
|
|
34
|
+
indexingStatus: JobIndexingStatus;
|
|
35
|
+
uploadProgress?: UploadJobProgress;
|
|
36
|
+
indexingProgress?: UploadJobProgress;
|
|
37
|
+
errors?: UploadJobError[];
|
|
38
|
+
rejected?: UploadJobRejection[];
|
|
39
|
+
initiatedBy?: string;
|
|
40
|
+
startedAt?: string;
|
|
41
|
+
completedAt?: string | null;
|
|
42
|
+
}
|
|
43
|
+
/** The jobs of one container. */
|
|
44
|
+
export interface UploadStatusContainer {
|
|
45
|
+
containerId: string;
|
|
46
|
+
containerName: string;
|
|
47
|
+
jobs?: UploadJobStatus[];
|
|
48
|
+
}
|
|
49
|
+
/** Response of `GET api/v2/document-upload/status`. */
|
|
50
|
+
export interface UploadStatusResponse {
|
|
51
|
+
/** Only containers the caller can read that have at least one job in the page. */
|
|
52
|
+
containers?: UploadStatusContainer[];
|
|
53
|
+
/** Match count BEFORE paging — not the length of `containers`. */
|
|
54
|
+
totalJobCount: number;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=upload-status.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload-status.d.ts","sourceRoot":"","sources":["../../../src/types/document-upload/upload-status.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,MAAM,MAAM,eAAe,GACvB,WAAW,GACX,iBAAiB,GACjB,oBAAoB,CAAC;AAEzB,sCAAsC;AACtC,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,UAAU,GACV,UAAU,GACV,QAAQ,GACR,aAAa,CAAC;AAElB,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,+CAA+C;AAC/C,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,eAAe,CAAC;IAC9B,cAAc,EAAE,iBAAiB,CAAC;IAClC,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,iCAAiC;AACjC,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;CAC1B;AAED,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,kFAAkF;IAClF,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACrC,kEAAkE;IAClE,aAAa,EAAE,MAAM,CAAC;CACvB"}
|
|
@@ -10,6 +10,12 @@ export interface SecurityPrincipal {
|
|
|
10
10
|
longName: string;
|
|
11
11
|
userId: string;
|
|
12
12
|
isGroup: boolean;
|
|
13
|
+
/** Set on users (`true`); absent or `false` on groups. */
|
|
14
|
+
isUser?: boolean;
|
|
15
|
+
/** Users only. Prefer it over `name` as a display label when present. */
|
|
16
|
+
fullName?: string;
|
|
17
|
+
/** Users only. */
|
|
18
|
+
email?: string;
|
|
13
19
|
}
|
|
14
20
|
/** Paginated response of `POST api/v1/security.principal`. */
|
|
15
21
|
export interface SecurityPrincipalSearchResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"security-principal.d.ts","sourceRoot":"","sources":["../../../src/types/security-principal/security-principal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"security-principal.d.ts","sourceRoot":"","sources":["../../../src/types/security-principal/security-principal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,8DAA8D;AAC9D,MAAM,WAAW,+BAA+B;IAC9C,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB"}
|
package/dist/web-api/index.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export * from "./v1/fetch-text-chunk";
|
|
|
17
17
|
export * from "./v1/fetch-user-settings";
|
|
18
18
|
export * from "./v2/fetch-change-password";
|
|
19
19
|
export * from "./v2/fetch-document-upload-container";
|
|
20
|
+
export * from "./v2/fetch-document-upload-status";
|
|
20
21
|
export * from "./v2/fetch-forgot-password";
|
|
21
22
|
export * from "./v2/fetch-user-profile";
|
|
22
23
|
export * from "./v2/fetch-version";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { type AtomicContext } from "../../client/atomic-context";
|
|
2
|
-
import type { SecurityPrincipalSearchResponse } from "../../types";
|
|
2
|
+
import type { SecurityPrincipal, SecurityPrincipalSearchResponse } from "../../types";
|
|
3
3
|
/**
|
|
4
4
|
* Searches Sinequa principals (users/groups) by free text, via the
|
|
5
|
-
* `security.principal` endpoint — search-as-you-type for assigning access
|
|
5
|
+
* `security.principal` endpoint (`action: "list"`) — search-as-you-type for assigning access
|
|
6
6
|
* (e.g. owners/readers) to a resource. Distinct from `fetchPrincipalList()`
|
|
7
7
|
* (`api/v1/principal/list`): same idea, different endpoint/response shape.
|
|
8
8
|
*
|
|
@@ -20,4 +20,20 @@ export declare function searchPrincipals(params: {
|
|
|
20
20
|
limit: number;
|
|
21
21
|
search: string;
|
|
22
22
|
}, signal?: AbortSignal, ctx?: AtomicContext): Promise<SecurityPrincipalSearchResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Resolves `domain|id` identities to principals, via the `security.principal`
|
|
25
|
+
* endpoint — what turns the bare `owners`/`readers` ids of a resource back
|
|
26
|
+
* into names.
|
|
27
|
+
*
|
|
28
|
+
* @param userIds - The identities to resolve; an empty array skips the request.
|
|
29
|
+
* @returns The principals the server could resolve. Unknown ids are simply
|
|
30
|
+
* absent, so the result may be shorter than `userIds` (a deleted account,
|
|
31
|
+
* say).
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* const owners = await fetchPrincipalsByIds(container.owners);
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
export declare function fetchPrincipalsByIds(userIds: string[], ctx?: AtomicContext): Promise<SecurityPrincipal[]>;
|
|
23
39
|
//# sourceMappingURL=fetch-security-principal.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fetch-security-principal.d.ts","sourceRoot":"","sources":["../../../src/web-api/v1/fetch-security-principal.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"fetch-security-principal.d.ts","sourceRoot":"","sources":["../../../src/web-api/v1/fetch-security-principal.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,iBAAiB,EACjB,+BAA+B,EAChC,MAAM,aAAa,CAAC;AAKrB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EACzD,MAAM,CAAC,EAAE,WAAW,EACpB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,+BAA+B,CAAC,CAO1C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAQ9B"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type AtomicContext } from "../../client/atomic-context";
|
|
2
|
-
import type { Container, ContainerDocumentListResponse, ContainerListResponse } from "../../types";
|
|
2
|
+
import type { Container, ContainerDocument, ContainerDocumentListResponse, ContainerListResponse } from "../../types";
|
|
3
|
+
import type { RequestOptions } from "../helpers/request-options";
|
|
3
4
|
/**
|
|
4
5
|
* Lists document-upload containers, paginated.
|
|
5
6
|
*
|
|
@@ -65,11 +66,25 @@ export declare function deleteContainers(containerIds: string[], ctx?: AtomicCon
|
|
|
65
66
|
*
|
|
66
67
|
* @param id - The container id.
|
|
67
68
|
* @param params - `page`/`pageSize` (server-side pagination; both optional).
|
|
69
|
+
* @param options - Request options; `signal` lets a poller abandon an in-flight request.
|
|
68
70
|
*/
|
|
69
71
|
export declare function listContainerDocuments(id: string, params?: {
|
|
70
72
|
page?: number;
|
|
71
73
|
pageSize?: number;
|
|
72
|
-
}, ctx?: AtomicContext): Promise<ContainerDocumentListResponse>;
|
|
74
|
+
}, options?: RequestOptions, ctx?: AtomicContext): Promise<ContainerDocumentListResponse>;
|
|
75
|
+
export interface NewContainerDocumentInput {
|
|
76
|
+
name: string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Attaches existing documents to a container (no file transfer).
|
|
80
|
+
*
|
|
81
|
+
* Provisional: the backend contract for this endpoint is not final yet.
|
|
82
|
+
*
|
|
83
|
+
* @param id - The container id.
|
|
84
|
+
* @param documents - The documents to attach.
|
|
85
|
+
* @returns The documents created in the container.
|
|
86
|
+
*/
|
|
87
|
+
export declare function addContainerDocuments(id: string, documents: NewContainerDocumentInput[], ctx?: AtomicContext): Promise<ContainerDocument[]>;
|
|
73
88
|
/**
|
|
74
89
|
* Deletes documents from a container by id.
|
|
75
90
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fetch-document-upload-container.d.ts","sourceRoot":"","sources":["../../../src/web-api/v2/fetch-document-upload-container.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,SAAS,EACT,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"fetch-document-upload-container.d.ts","sourceRoot":"","sources":["../../../src/web-api/v2/fetch-document-upload-container.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,SAAS,EACT,iBAAiB,EACjB,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAKrB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AA2BjE;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,MAAM,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,EACjD,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,qBAAqB,CAAC,CAEhC;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,EAAE,EAAE,MAAM,EACV,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,SAAS,CAAC,CAEpB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,oBAAoB,EAC1B,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,SAAS,CAAC,CAEpB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,oBAAoB,EAC3B,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,SAAS,CAAC,CAMpB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAClD;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,YAAY,EAAE,MAAM,EAAE,EACtB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAUjC;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAC1C,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAC7C,OAAO,CAAC,EAAE,cAAc,EACxB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,6BAA6B,CAAC,CASxC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CACzC,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,yBAAyB,EAAE,EACtC,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAO9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,IAAI,CAAC,CASf"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { type AtomicContext } from "../../client/atomic-context";
|
|
2
|
+
import type { UploadStatusResponse } from "../../types";
|
|
3
|
+
import type { RequestOptions } from "../helpers/request-options";
|
|
4
|
+
export interface UploadStatusParams {
|
|
5
|
+
/** Restrict to one container (the cheaper per-container lookup server-side). */
|
|
6
|
+
containerId?: string;
|
|
7
|
+
/** Restrict to jobs started by this user id. */
|
|
8
|
+
initiatedBy?: string;
|
|
9
|
+
/** Jobs to skip (default 0). */
|
|
10
|
+
skip?: number;
|
|
11
|
+
/** Jobs to return (default 50, capped at 200 server-side). */
|
|
12
|
+
take?: number;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Returns document-upload jobs grouped by container, most-recently-started
|
|
16
|
+
* first.
|
|
17
|
+
*
|
|
18
|
+
* @param params - Optional filters and paging (see {@link UploadStatusParams}).
|
|
19
|
+
* @param options - Request options; pass `signal` so an in-flight poll can be
|
|
20
|
+
* abandoned.
|
|
21
|
+
*/
|
|
22
|
+
export declare function fetchUploadStatus(params?: UploadStatusParams, options?: RequestOptions, ctx?: AtomicContext): Promise<UploadStatusResponse>;
|
|
23
|
+
//# sourceMappingURL=fetch-document-upload-status.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetch-document-upload-status.d.ts","sourceRoot":"","sources":["../../../src/web-api/v2/fetch-document-upload-status.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE,MAAM,WAAW,kBAAkB;IACjC,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,EACxB,GAAG,GAAE,aAA8B,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAS/B"}
|