@fusebase/fusebase-gate-sdk 2.2.11-sdk.4 → 2.2.11-sdk.6
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/apis/FilesApi.d.ts +3 -25
- package/dist/apis/FilesApi.js +1 -31
- package/dist/apis/NotesApi.d.ts +6 -6
- package/dist/apis/NotesApi.js +6 -6
- package/dist/types/file/file.d.ts +2 -58
- package/dist/types/file/file.js +1 -8
- package/package.json +1 -1
- package/release-notes/2.2.11-sdk.6.md +9 -0
- package/release-notes/latest.md +3 -3
- package/release-notes/2.2.11-sdk.4.md +0 -9
package/dist/apis/FilesApi.d.ts
CHANGED
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
* Domain: files
|
|
6
6
|
*/
|
|
7
7
|
import type { Client } from "../runtime/transport";
|
|
8
|
-
import type { CompleteMultipartFileUploadRequestContract, CompleteMultipartFileUploadResponseContract, DeleteFileRequestContract, DeleteFileResponseContract,
|
|
8
|
+
import type { CompleteMultipartFileUploadRequestContract, CompleteMultipartFileUploadResponseContract, DeleteFileRequestContract, DeleteFileResponseContract, MultipartUploadIdInPathRequired, orgIdInPathRequired, StartMultipartFileUploadRequestContract, StartMultipartFileUploadResponseContract } from "../types";
|
|
9
9
|
export declare class FilesApi {
|
|
10
10
|
private client;
|
|
11
11
|
constructor(client: Client);
|
|
12
12
|
/**
|
|
13
13
|
* Complete multipart file upload
|
|
14
|
-
* Finishes a file-service multipart upload, then creates the stored-file record that downstream note attachment flows use.
|
|
14
|
+
* Finishes a public file-service multipart upload, then creates the stored-file record that downstream note attachment flows use. The response includes a stable public readUrl suitable for image src usage.
|
|
15
15
|
*/
|
|
16
16
|
completeMultipartFileUpload(params: {
|
|
17
17
|
path: {
|
|
@@ -32,28 +32,6 @@ export declare class FilesApi {
|
|
|
32
32
|
headers?: Record<string, string>;
|
|
33
33
|
body: DeleteFileRequestContract;
|
|
34
34
|
}): Promise<DeleteFileResponseContract>;
|
|
35
|
-
/**
|
|
36
|
-
* Get file read URL
|
|
37
|
-
* Builds a public file-service read URL from the public object name returned by completeMultipartFileUpload. Gate never handles the file bytes.
|
|
38
|
-
*/
|
|
39
|
-
getFileDownloadUrl(params: {
|
|
40
|
-
path: {
|
|
41
|
-
orgId: orgIdInPathRequired;
|
|
42
|
-
};
|
|
43
|
-
headers?: Record<string, string>;
|
|
44
|
-
body: GetFileDownloadUrlRequestContract;
|
|
45
|
-
}): Promise<GetFileDownloadUrlResponseContract>;
|
|
46
|
-
/**
|
|
47
|
-
* Prepare direct file upload
|
|
48
|
-
* Starts a file-service multipart upload and returns the first direct PUT URL. Clients upload bytes directly to the returned URL, then call completeMultipartFileUpload with the returned uploadId, tempStoredfileName, and uploaded part ETag.
|
|
49
|
-
*/
|
|
50
|
-
prepareFileUpload(params: {
|
|
51
|
-
path: {
|
|
52
|
-
orgId: orgIdInPathRequired;
|
|
53
|
-
};
|
|
54
|
-
headers?: Record<string, string>;
|
|
55
|
-
body: PrepareFileUploadRequestContract;
|
|
56
|
-
}): Promise<PrepareFileUploadResponseContract>;
|
|
57
35
|
/**
|
|
58
36
|
* Start multipart file upload
|
|
59
37
|
* Starts a file-service multipart upload and returns direct PUT URLs. Clients upload each part to the returned URLs, keep each response ETag, and pass those ETags to completeMultipartFileUpload.
|
|
@@ -63,6 +41,6 @@ export declare class FilesApi {
|
|
|
63
41
|
orgId: orgIdInPathRequired;
|
|
64
42
|
};
|
|
65
43
|
headers?: Record<string, string>;
|
|
66
|
-
body:
|
|
44
|
+
body: StartMultipartFileUploadRequestContract;
|
|
67
45
|
}): Promise<StartMultipartFileUploadResponseContract>;
|
|
68
46
|
}
|
package/dist/apis/FilesApi.js
CHANGED
|
@@ -13,7 +13,7 @@ class FilesApi {
|
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* Complete multipart file upload
|
|
16
|
-
* Finishes a file-service multipart upload, then creates the stored-file record that downstream note attachment flows use.
|
|
16
|
+
* Finishes a public file-service multipart upload, then creates the stored-file record that downstream note attachment flows use. The response includes a stable public readUrl suitable for image src usage.
|
|
17
17
|
*/
|
|
18
18
|
async completeMultipartFileUpload(params) {
|
|
19
19
|
return this.client.request({
|
|
@@ -41,36 +41,6 @@ class FilesApi {
|
|
|
41
41
|
expectedContentType: "application/json",
|
|
42
42
|
});
|
|
43
43
|
}
|
|
44
|
-
/**
|
|
45
|
-
* Get file read URL
|
|
46
|
-
* Builds a public file-service read URL from the public object name returned by completeMultipartFileUpload. Gate never handles the file bytes.
|
|
47
|
-
*/
|
|
48
|
-
async getFileDownloadUrl(params) {
|
|
49
|
-
return this.client.request({
|
|
50
|
-
method: "POST",
|
|
51
|
-
path: "/:orgId/files/download-url",
|
|
52
|
-
pathParams: params.path,
|
|
53
|
-
headers: params.headers,
|
|
54
|
-
body: params.body,
|
|
55
|
-
opId: "getFileDownloadUrl",
|
|
56
|
-
expectedContentType: "application/json",
|
|
57
|
-
});
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* Prepare direct file upload
|
|
61
|
-
* Starts a file-service multipart upload and returns the first direct PUT URL. Clients upload bytes directly to the returned URL, then call completeMultipartFileUpload with the returned uploadId, tempStoredfileName, and uploaded part ETag.
|
|
62
|
-
*/
|
|
63
|
-
async prepareFileUpload(params) {
|
|
64
|
-
return this.client.request({
|
|
65
|
-
method: "POST",
|
|
66
|
-
path: "/:orgId/files/prepare-upload",
|
|
67
|
-
pathParams: params.path,
|
|
68
|
-
headers: params.headers,
|
|
69
|
-
body: params.body,
|
|
70
|
-
opId: "prepareFileUpload",
|
|
71
|
-
expectedContentType: "application/json",
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
44
|
/**
|
|
75
45
|
* Start multipart file upload
|
|
76
46
|
* Starts a file-service multipart upload and returns direct PUT URLs. Clients upload each part to the returned URLs, keep each response ETag, and pass those ETags to completeMultipartFileUpload.
|
package/dist/apis/NotesApi.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ export declare class NotesApi {
|
|
|
11
11
|
constructor(client: Client);
|
|
12
12
|
/**
|
|
13
13
|
* Add workspace note attachment
|
|
14
|
-
* Attaches a stored-file UUID from the files upload flow to a workspace note, then appends an image blot for image attachments or a file blot for all other attachment types.
|
|
14
|
+
* Attaches a stored-file UUID from the files upload flow to a workspace note, then appends an image blot for image attachments or a file blot for all other attachment types. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server.
|
|
15
15
|
*/
|
|
16
16
|
addWorkspaceNoteAttachment(params: {
|
|
17
17
|
path: {
|
|
@@ -24,7 +24,7 @@ export declare class NotesApi {
|
|
|
24
24
|
}): Promise<AddWorkspaceNoteAttachmentResponseContract>;
|
|
25
25
|
/**
|
|
26
26
|
* Create workspace note
|
|
27
|
-
* Creates a note in the requested workspace. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
27
|
+
* Creates a note in the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
28
28
|
*/
|
|
29
29
|
createWorkspaceNote(params: {
|
|
30
30
|
path: {
|
|
@@ -36,7 +36,7 @@ export declare class NotesApi {
|
|
|
36
36
|
}): Promise<CreateWorkspaceNoteResponseContract>;
|
|
37
37
|
/**
|
|
38
38
|
* Create workspace note folder
|
|
39
|
-
* Creates a folder in the requested workspace. When parentId is omitted, gate uses `default`.
|
|
39
|
+
* Creates a folder in the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service. When parentId is omitted, gate uses `default`.
|
|
40
40
|
*/
|
|
41
41
|
createWorkspaceNoteFolder(params: {
|
|
42
42
|
path: {
|
|
@@ -48,7 +48,7 @@ export declare class NotesApi {
|
|
|
48
48
|
}): Promise<CreateWorkspaceNoteFolderResponseContract>;
|
|
49
49
|
/**
|
|
50
50
|
* Read workspace note
|
|
51
|
-
* Returns the note title, parent metadata, and md content for the requested workspace note.
|
|
51
|
+
* Returns the note title, parent metadata, and md content for the requested workspace note. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server.
|
|
52
52
|
*/
|
|
53
53
|
getWorkspaceNote(params: {
|
|
54
54
|
path: {
|
|
@@ -60,7 +60,7 @@ export declare class NotesApi {
|
|
|
60
60
|
}): Promise<WorkspaceNoteContentResponseContract>;
|
|
61
61
|
/**
|
|
62
62
|
* List workspace note folders
|
|
63
|
-
* Returns non-portal note folders for the requested workspace.
|
|
63
|
+
* Returns non-portal note folders for the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service.
|
|
64
64
|
*/
|
|
65
65
|
listWorkspaceNoteFolders(params: {
|
|
66
66
|
path: {
|
|
@@ -71,7 +71,7 @@ export declare class NotesApi {
|
|
|
71
71
|
}): Promise<WorkspaceNoteFolderListResponseContract>;
|
|
72
72
|
/**
|
|
73
73
|
* List workspace notes
|
|
74
|
-
* Returns non-portal notes for the requested workspace and parent folder. When parentId is omitted, gate defaults to the workspace default folder id `default`.
|
|
74
|
+
* Returns non-portal notes for the requested workspace and parent folder. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service. When parentId is omitted, gate defaults to the workspace default folder id `default`.
|
|
75
75
|
*/
|
|
76
76
|
listWorkspaceNotes(params: {
|
|
77
77
|
path: {
|
package/dist/apis/NotesApi.js
CHANGED
|
@@ -13,7 +13,7 @@ class NotesApi {
|
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* Add workspace note attachment
|
|
16
|
-
* Attaches a stored-file UUID from the files upload flow to a workspace note, then appends an image blot for image attachments or a file blot for all other attachment types.
|
|
16
|
+
* Attaches a stored-file UUID from the files upload flow to a workspace note, then appends an image blot for image attachments or a file blot for all other attachment types. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server.
|
|
17
17
|
*/
|
|
18
18
|
async addWorkspaceNoteAttachment(params) {
|
|
19
19
|
return this.client.request({
|
|
@@ -28,7 +28,7 @@ class NotesApi {
|
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
30
|
* Create workspace note
|
|
31
|
-
* Creates a note in the requested workspace. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
31
|
+
* Creates a note in the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
32
32
|
*/
|
|
33
33
|
async createWorkspaceNote(params) {
|
|
34
34
|
return this.client.request({
|
|
@@ -43,7 +43,7 @@ class NotesApi {
|
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* Create workspace note folder
|
|
46
|
-
* Creates a folder in the requested workspace. When parentId is omitted, gate uses `default`.
|
|
46
|
+
* Creates a folder in the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service. When parentId is omitted, gate uses `default`.
|
|
47
47
|
*/
|
|
48
48
|
async createWorkspaceNoteFolder(params) {
|
|
49
49
|
return this.client.request({
|
|
@@ -58,7 +58,7 @@ class NotesApi {
|
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
60
|
* Read workspace note
|
|
61
|
-
* Returns the note title, parent metadata, and md content for the requested workspace note.
|
|
61
|
+
* Returns the note title, parent metadata, and md content for the requested workspace note. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service and editor-server.
|
|
62
62
|
*/
|
|
63
63
|
async getWorkspaceNote(params) {
|
|
64
64
|
return this.client.request({
|
|
@@ -72,7 +72,7 @@ class NotesApi {
|
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* List workspace note folders
|
|
75
|
-
* Returns non-portal note folders for the requested workspace.
|
|
75
|
+
* Returns non-portal note folders for the requested workspace. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service.
|
|
76
76
|
*/
|
|
77
77
|
async listWorkspaceNoteFolders(params) {
|
|
78
78
|
return this.client.request({
|
|
@@ -86,7 +86,7 @@ class NotesApi {
|
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
88
|
* List workspace notes
|
|
89
|
-
* Returns non-portal notes for the requested workspace and parent folder. When parentId is omitted, gate defaults to the workspace default folder id `default`.
|
|
89
|
+
* Returns non-portal notes for the requested workspace and parent folder. Prefer a real workspace id; when the path workspaceId is `default`, gate resolves it to the organization's default workspace before calling note-service. When parentId is omitted, gate defaults to the workspace default folder id `default`.
|
|
90
90
|
*/
|
|
91
91
|
async listWorkspaceNotes(params) {
|
|
92
92
|
return this.client.request({
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
export type FileIdInPathRequired = string;
|
|
2
2
|
export type MultipartUploadIdInPathRequired = string;
|
|
3
3
|
export type FileUploadMethodContract = "PUT";
|
|
4
|
-
export
|
|
5
|
-
export type FileReadDispositionContract = "inline" | "attachment";
|
|
6
|
-
export interface PrepareFileUploadRequestContract {
|
|
4
|
+
export interface StartMultipartFileUploadRequestContract {
|
|
7
5
|
filename: string;
|
|
8
6
|
size: number;
|
|
9
7
|
contentType?: string | null;
|
|
@@ -12,57 +10,14 @@ export interface PrepareFileUploadRequestContract {
|
|
|
12
10
|
export interface DeleteFileRequestContract {
|
|
13
11
|
fileId: string;
|
|
14
12
|
}
|
|
15
|
-
export interface GetFileDownloadUrlRequestContract {
|
|
16
|
-
/**
|
|
17
|
-
* Public file-service object name returned as `publicFileName` by completeMultipartFileUpload.
|
|
18
|
-
*/
|
|
19
|
-
fileName: string;
|
|
20
|
-
disposition?: FileReadDispositionContract | null;
|
|
21
|
-
}
|
|
22
13
|
export interface FileUploadHeadersContract {
|
|
23
14
|
"Content-Type": string;
|
|
24
15
|
"Content-Length"?: string;
|
|
25
16
|
}
|
|
26
|
-
export interface PrepareFileUploadResponseContract {
|
|
27
|
-
/**
|
|
28
|
-
* Temporary stored-file name. Complete the upload to receive the stored-file UUID.
|
|
29
|
-
*/
|
|
30
|
-
fileId: string;
|
|
31
|
-
/**
|
|
32
|
-
* @format uri
|
|
33
|
-
*/
|
|
34
|
-
uploadUrl: string;
|
|
35
|
-
/**
|
|
36
|
-
* @format uri
|
|
37
|
-
*/
|
|
38
|
-
partsUrls: string[];
|
|
39
|
-
partSize: number;
|
|
40
|
-
method: FileUploadMethodContract;
|
|
41
|
-
headers: FileUploadHeadersContract;
|
|
42
|
-
uploadId: string;
|
|
43
|
-
tempStoredfileName: string;
|
|
44
|
-
partNumber: number;
|
|
45
|
-
/**
|
|
46
|
-
* @format date-time
|
|
47
|
-
*/
|
|
48
|
-
expiresAt: string | null;
|
|
49
|
-
}
|
|
50
17
|
export interface DeleteFileResponseContract {
|
|
51
18
|
fileId: string;
|
|
52
19
|
deleted: boolean;
|
|
53
20
|
}
|
|
54
|
-
export interface GetFileDownloadUrlResponseContract {
|
|
55
|
-
fileName: string;
|
|
56
|
-
/**
|
|
57
|
-
* @format uri
|
|
58
|
-
*/
|
|
59
|
-
downloadUrl: string;
|
|
60
|
-
method: FileDownloadMethodContract;
|
|
61
|
-
/**
|
|
62
|
-
* @format date-time
|
|
63
|
-
*/
|
|
64
|
-
expiresAt: string | null;
|
|
65
|
-
}
|
|
66
21
|
export interface StartMultipartFileUploadResponseContract {
|
|
67
22
|
/**
|
|
68
23
|
* File-service multipart upload id. Treat as opaque and send it back unchanged.
|
|
@@ -82,10 +37,6 @@ export interface StartMultipartFileUploadResponseContract {
|
|
|
82
37
|
headers: FileUploadHeadersContract;
|
|
83
38
|
tempStoredfileName: string;
|
|
84
39
|
partNumber: number;
|
|
85
|
-
/**
|
|
86
|
-
* @format date-time
|
|
87
|
-
*/
|
|
88
|
-
expiresAt: string | null;
|
|
89
40
|
}
|
|
90
41
|
export interface CompleteMultipartFileUploadPartContract {
|
|
91
42
|
etag: string;
|
|
@@ -108,7 +59,7 @@ export interface CompleteMultipartFileUploadResponseContract {
|
|
|
108
59
|
* Public URL built from the file-service public object name.
|
|
109
60
|
* @format uri
|
|
110
61
|
*/
|
|
111
|
-
|
|
62
|
+
readUrl: string;
|
|
112
63
|
committed: boolean;
|
|
113
64
|
partCount: number;
|
|
114
65
|
filename: string;
|
|
@@ -119,10 +70,3 @@ export interface CompleteMultipartFileUploadResponseContract {
|
|
|
119
70
|
export declare const FileUploadMethodContract: {
|
|
120
71
|
readonly Put: "PUT";
|
|
121
72
|
};
|
|
122
|
-
export declare const FileDownloadMethodContract: {
|
|
123
|
-
readonly Get: "GET";
|
|
124
|
-
};
|
|
125
|
-
export declare const FileReadDispositionContract: {
|
|
126
|
-
readonly Inline: "inline";
|
|
127
|
-
readonly Attachment: "attachment";
|
|
128
|
-
};
|
package/dist/types/file/file.js
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.FileUploadMethodContract = void 0;
|
|
4
4
|
exports.FileUploadMethodContract = {
|
|
5
5
|
Put: "PUT"
|
|
6
6
|
};
|
|
7
|
-
exports.FileDownloadMethodContract = {
|
|
8
|
-
Get: "GET"
|
|
9
|
-
};
|
|
10
|
-
exports.FileReadDispositionContract = {
|
|
11
|
-
Inline: "inline",
|
|
12
|
-
Attachment: "attachment"
|
|
13
|
-
};
|
package/package.json
CHANGED
package/release-notes/latest.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Release Notes 2.2.11-sdk.
|
|
1
|
+
# Release Notes 2.2.11-sdk.6
|
|
2
2
|
|
|
3
3
|
- Current ref: `HEAD`
|
|
4
|
-
- Previous tag: `v2.2.11-sdk.
|
|
5
|
-
- Generated at: 2026-04-
|
|
4
|
+
- Previous tag: `v2.2.11-sdk.6`
|
|
5
|
+
- Generated at: 2026-04-28T07:14:08.829Z
|
|
6
6
|
|
|
7
7
|
## Included Drafts
|
|
8
8
|
|