@univerjs/protocol 0.1.19 → 0.1.21

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.
@@ -1,74 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- import type { RowData } from "../univer/workbook";
5
- import type { DisplayerConfig } from "./source_connector/displayer";
6
- import type { SelectColumn, WhereGroup as WhereGroup1 } from "./source_connector/stream_view";
7
- export declare const protobufPackage = "universer.v1";
8
- export interface Connector {
9
- connectorID: string;
10
- name: string;
11
- }
12
- export interface Displayer {
13
- diplayerID: string;
14
- name: string;
15
- }
16
- export interface WhereGroup {
17
- group: string;
18
- conditions: WhereCondition[];
19
- }
20
- export interface WhereCondition {
21
- column: string;
22
- value: any[];
23
- }
24
- export interface ListDisplayersRequest {
25
- }
26
- export interface ListDisplayersResponse {
27
- error: Error | undefined;
28
- displayers: Displayer[];
29
- }
30
- export interface GetDisplayerRequest {
31
- displayerID: string;
32
- }
33
- export interface GetDisplayerResponse {
34
- error: Error | undefined;
35
- display: DisplayerConfig | undefined;
36
- }
37
- export interface GetStreamViewRequest {
38
- viewID: string;
39
- }
40
- export interface GetStreamViewResponse {
41
- error: Error | undefined;
42
- select: SelectColumn[];
43
- where: WhereGroup1[];
44
- }
45
- export interface GetStreamViewRownumResponse {
46
- error: Error | undefined;
47
- rownum: number;
48
- }
49
- export interface StreamViewQueryRequest {
50
- viewID: string;
51
- schedule: string;
52
- select: string[];
53
- where: WhereGroup[];
54
- }
55
- export interface QueryResponse {
56
- error: Error | undefined;
57
- nextCursor: string;
58
- dataformID: string;
59
- celldatas: RowData[];
60
- columns: string[];
61
- }
62
- export interface DataformQueryRequest {
63
- dataformID: string;
64
- cursor: string;
65
- }
66
- export interface ConnectorService {
67
- ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
68
- GetDisplayer(request: GetDisplayerRequest, metadata?: Metadata): Observable<GetDisplayerResponse>;
69
- GetStreamView(request: GetStreamViewRequest, metadata?: Metadata): Observable<GetStreamViewResponse>;
70
- GetStreamViewRownum(request: StreamViewQueryRequest, metadata?: Metadata): Observable<GetStreamViewRownumResponse>;
71
- StreamViewPreview(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
72
- StreamViewQuery(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
73
- DataformQuery(request: DataformQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
74
- }
@@ -1,83 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- import type { UniverType } from "../univer/constants/univer";
5
- import type { Snapshot } from "../univer/snapshot";
6
- import type { SheetBlock } from "../univer/workbook";
7
- export declare const protobufPackage = "universer.v1";
8
- export declare enum ImportOutputType {
9
- UNDEFINED = 0,
10
- /** UNIT - Import to univer unit, unit is store in the database */
11
- UNIT = 1,
12
- /** JSON - Import and convert to a json file which represents a univer unit, not store in the database */
13
- JSON = 2,
14
- UNRECOGNIZED = -1
15
- }
16
- export interface ImportRequest {
17
- fileID: string;
18
- type: UniverType;
19
- outputType: ImportOutputType;
20
- /** not supported yet */
21
- fileUrl: string;
22
- }
23
- export interface ImportResponse {
24
- error: Error | undefined;
25
- taskID: string;
26
- }
27
- export interface ExportRequest {
28
- /** if unitID is specified, the input is the unit in the database */
29
- unitID: string;
30
- /** if jsonID is specified, the input is the json file which represents a univer unit */
31
- jsonID: string;
32
- type: UniverType;
33
- }
34
- export interface ExportResponse {
35
- error: Error | undefined;
36
- taskID: string;
37
- }
38
- export interface GetTaskRequest {
39
- taskID: string;
40
- }
41
- export interface GetTaskResponse {
42
- error: Error | undefined;
43
- taskID: string;
44
- status: string;
45
- import?: ImportTaskResult | undefined;
46
- export?: ExportTaskResult | undefined;
47
- }
48
- export interface ImportTaskResult {
49
- outputType: ImportOutputType;
50
- unitID: string;
51
- jsonID: string;
52
- }
53
- export interface ExportTaskResult {
54
- fileID: string;
55
- fileUrl: string;
56
- }
57
- export interface UpdateTaskRequest {
58
- taskID: string;
59
- status: string;
60
- data: Uint8Array;
61
- }
62
- export interface UpdateTaskResponse {
63
- error: Error | undefined;
64
- }
65
- /** The json file which represents a univer unit */
66
- export interface UniverFileInJsonFmt {
67
- /** TODO: need to consider more than one snapshot in a univer file */
68
- snapshot: Snapshot | undefined;
69
- /** key is the blockID, value is the sheet block */
70
- sheetBlocks: {
71
- [key: string]: SheetBlock;
72
- };
73
- }
74
- export interface UniverFileInJsonFmt_SheetBlocksEntry {
75
- key: string;
76
- value: SheetBlock | undefined;
77
- }
78
- export interface ExchangeService {
79
- Import(request: ImportRequest, metadata?: Metadata): Observable<ImportResponse>;
80
- Export(request: ExportRequest, metadata?: Metadata): Observable<ExportResponse>;
81
- GetTask(request: GetTaskRequest, metadata?: Metadata): Observable<GetTaskResponse>;
82
- UpdateTask(request: UpdateTaskRequest, metadata?: Metadata): Observable<UpdateTaskResponse>;
83
- }
@@ -1,28 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- export declare const protobufPackage = "universer.v1";
5
- export interface SignUrlRequest {
6
- fileID: string;
7
- }
8
- export interface SignUrlResponse {
9
- error: Error | undefined;
10
- url: string;
11
- }
12
- export interface FileUploadMeta {
13
- fileName: string;
14
- fileHash: string;
15
- fileSize: number;
16
- }
17
- export interface FileUploadRequest {
18
- data?: Uint8Array | undefined;
19
- meta?: FileUploadMeta | undefined;
20
- }
21
- export interface UploadResponse {
22
- error: Error | undefined;
23
- fileID: string;
24
- }
25
- export interface FileService {
26
- SignUrl(request: SignUrlRequest, metadata?: Metadata): Observable<SignUrlResponse>;
27
- Upload(request: Observable<FileUploadRequest>, metadata?: Metadata): Observable<UploadResponse>;
28
- }
@@ -1,24 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- export declare const protobufPackage = "universer.v1";
5
- export interface Oauth2PageRequest {
6
- url: string;
7
- }
8
- export interface Oauth2PageResponse {
9
- error: Error | undefined;
10
- redirectUri: string;
11
- }
12
- export interface Oauth2CallbackRequest {
13
- code: string;
14
- state: string;
15
- redirectUri: string;
16
- }
17
- export interface Oauth2CallbackResponse {
18
- error: Error | undefined;
19
- redirectUri: string;
20
- }
21
- export interface Oauth2Service {
22
- AuthPage(request: Oauth2PageRequest, metadata?: Metadata): Observable<Oauth2PageResponse>;
23
- AuthCallback(request: Oauth2CallbackRequest, metadata?: Metadata): Observable<Oauth2CallbackResponse>;
24
- }
@@ -1,24 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- export declare const protobufPackage = "universer.v1";
5
- export interface AuthRedirectRequest {
6
- url: string;
7
- }
8
- export interface AuthRedirectResponse {
9
- error: Error | undefined;
10
- redirectUri: string;
11
- }
12
- export interface AuthCallbackRequest {
13
- code: string;
14
- state: string;
15
- redirectUri: string;
16
- }
17
- export interface AuthCallbackResponse {
18
- error: Error | undefined;
19
- redirectUri: string;
20
- }
21
- export interface OIDCService {
22
- AuthRedirect(request: AuthRedirectRequest, metadata?: Metadata): Observable<AuthRedirectResponse>;
23
- AuthCallback(request: AuthCallbackRequest, metadata?: Metadata): Observable<AuthCallbackResponse>;
24
- }
@@ -1,110 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- export declare const protobufPackage = "universer.v1.source_connector";
4
- export interface ModelConnector {
5
- uuid: string;
6
- config: string;
7
- name: string;
8
- }
9
- export interface ModelStreamView {
10
- uuid: string;
11
- config: string;
12
- name: string;
13
- }
14
- export interface ModelDisplayer {
15
- uuid: string;
16
- config: string;
17
- name: string;
18
- }
19
- export interface CreateConnectorRequest {
20
- config: string;
21
- name: string;
22
- }
23
- export interface CreateConnectorResponse {
24
- }
25
- export interface ListConnectorsRequest {
26
- all: boolean;
27
- uuids: string[];
28
- }
29
- export interface ListConnectorsResponse {
30
- connectors: ModelConnector[];
31
- }
32
- export interface UpdateConnectorRequest {
33
- uuid: string;
34
- config: string;
35
- name: string;
36
- }
37
- export interface UpdateConnectorResponse {
38
- }
39
- export interface DeleteConnectorRequest {
40
- uuid: string;
41
- }
42
- export interface DeleteConnectorResponse {
43
- }
44
- export interface CreateStreamViewRequest {
45
- config: string;
46
- }
47
- export interface CreateStreamViewResponse {
48
- }
49
- export interface ListStreamViewsRequest {
50
- all: boolean;
51
- uuids: string[];
52
- }
53
- export interface ListStreamViewsResponse {
54
- streamViews: ModelStreamView[];
55
- }
56
- export interface UpdateStreamViewRequest {
57
- uuid: string;
58
- config: string;
59
- }
60
- export interface UpdateStreamViewResponse {
61
- }
62
- export interface DeleteStreamViewRequest {
63
- uuid: string;
64
- }
65
- export interface DeleteStreamViewResponse {
66
- }
67
- export interface StreamViewTestRequest {
68
- config: string;
69
- }
70
- export interface StreamViewTestResponse {
71
- result: string;
72
- }
73
- export interface CreateDisplayerRequest {
74
- config: string;
75
- }
76
- export interface CreateDisplayerResponse {
77
- }
78
- export interface ListDisplayersRequest {
79
- all: boolean;
80
- uuids: string[];
81
- }
82
- export interface ListDisplayersResponse {
83
- displayers: ModelDisplayer[];
84
- }
85
- export interface UpdateDisplayerRequest {
86
- uuid: string;
87
- config: string;
88
- }
89
- export interface UpdateDisplayerResponse {
90
- }
91
- export interface DeleteDisplayerRequest {
92
- uuid: string;
93
- }
94
- export interface DeleteDisplayerResponse {
95
- }
96
- export interface ConnectorService {
97
- CreateConnector(request: CreateConnectorRequest, metadata?: Metadata): Observable<CreateConnectorResponse>;
98
- ListConnectors(request: ListConnectorsRequest, metadata?: Metadata): Observable<ListConnectorsResponse>;
99
- UpdateConnector(request: UpdateConnectorRequest, metadata?: Metadata): Observable<UpdateConnectorResponse>;
100
- DeleteConnector(request: DeleteConnectorRequest, metadata?: Metadata): Observable<DeleteConnectorResponse>;
101
- CreateStreamView(request: CreateStreamViewRequest, metadata?: Metadata): Observable<CreateStreamViewResponse>;
102
- ListStreamViews(request: ListStreamViewsRequest, metadata?: Metadata): Observable<ListStreamViewsResponse>;
103
- UpdateStreamView(request: UpdateStreamViewRequest, metadata?: Metadata): Observable<UpdateStreamViewResponse>;
104
- DeleteStreamView(request: DeleteStreamViewRequest, metadata?: Metadata): Observable<DeleteStreamViewResponse>;
105
- StreamViewTest(request: StreamViewTestRequest, metadata?: Metadata): Observable<StreamViewTestResponse>;
106
- CreateDisplayer(request: CreateDisplayerRequest, metadata?: Metadata): Observable<CreateDisplayerResponse>;
107
- ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
108
- UpdateDisplayer(request: UpdateDisplayerRequest, metadata?: Metadata): Observable<UpdateDisplayerResponse>;
109
- DeleteDisplayer(request: DeleteDisplayerRequest, metadata?: Metadata): Observable<DeleteDisplayerResponse>;
110
- }
@@ -1,29 +0,0 @@
1
- import type { Airtable, BigQuery, GoogleSheet, Mysql, Notion, Postgresql, Salesforce, SpacexApi } from "./source";
2
- export declare const protobufPackage = "universer.v1.source_connector";
3
- export interface ConnectorConfig {
4
- connector: Connector | undefined;
5
- streams: Stream[];
6
- }
7
- export interface Connector {
8
- type: string;
9
- schedule: string;
10
- postgresql?: Postgresql | undefined;
11
- mysql?: Mysql | undefined;
12
- airtable?: Airtable | undefined;
13
- googleSheet?: GoogleSheet | undefined;
14
- salesforce?: Salesforce | undefined;
15
- notion?: Notion | undefined;
16
- bigquery?: BigQuery | undefined;
17
- spacexApi?: SpacexApi | undefined;
18
- }
19
- export interface StreamSchema {
20
- name: string;
21
- displayName: string;
22
- type: string;
23
- value: string[];
24
- }
25
- export interface Stream {
26
- name: string;
27
- displayName: string;
28
- schema: StreamSchema[];
29
- }
@@ -1,16 +0,0 @@
1
- export declare const protobufPackage = "universer.v1.source_connector";
2
- export interface DisplayerConfig {
3
- type: string;
4
- name: string;
5
- uuid: string;
6
- nodes: Node[];
7
- }
8
- export interface Node {
9
- name: string;
10
- child: Node[];
11
- views: View[];
12
- }
13
- export interface View {
14
- viewID: string;
15
- name: string;
16
- }
@@ -1,46 +0,0 @@
1
- export declare const protobufPackage = "universer.v1.source_connector";
2
- export interface Postgresql {
3
- host: string;
4
- port: number;
5
- schema: string;
6
- database: string;
7
- username: string;
8
- password: string;
9
- replicationMethod: Postgresql_ReplicationMethod | undefined;
10
- }
11
- export interface Postgresql_ReplicationMethod {
12
- method: string;
13
- replicationSlot: string;
14
- publication: string;
15
- }
16
- export interface Mysql {
17
- host: string;
18
- port: number;
19
- database: string;
20
- username: string;
21
- password: string;
22
- }
23
- export interface Airtable {
24
- token: string;
25
- }
26
- export interface GoogleSheet {
27
- sheetShareUrl: string;
28
- serviceAccountInfo: string;
29
- }
30
- export interface Salesforce {
31
- clientID: string;
32
- clientSecret: string;
33
- refreshToken: string;
34
- }
35
- export interface Notion {
36
- token: string;
37
- }
38
- export interface BigQuery {
39
- projectID: string;
40
- datasetID: string;
41
- credentialsJson: string;
42
- }
43
- export interface SpacexApi {
44
- clientID: string;
45
- options: string;
46
- }
@@ -1,31 +0,0 @@
1
- export declare const protobufPackage = "universer.v1.source_connector";
2
- export interface StreamViewConfig {
3
- info: StreamViewInfo | undefined;
4
- select: SelectColumn[];
5
- where: WhereGroup[];
6
- sql: string;
7
- }
8
- export interface StreamViewInfo {
9
- name: string;
10
- uuid: string;
11
- }
12
- export interface SelectColumn {
13
- name: string;
14
- value: string;
15
- }
16
- export interface WhereGroup {
17
- group: string;
18
- name: string;
19
- conditions: WhereCondition[];
20
- }
21
- export interface WhereCondition {
22
- column: string;
23
- name: string;
24
- type: string;
25
- sql: string;
26
- radio: WhereRadio[];
27
- }
28
- export interface WhereRadio {
29
- name: string;
30
- value: string;
31
- }
@@ -1,18 +0,0 @@
1
- import { Metadata } from "@grpc/grpc-js";
2
- import { Observable } from "rxjs";
3
- import type { Error } from "../univer/constants/errors";
4
- export declare const protobufPackage = "universer.v1";
5
- export interface User {
6
- userID: string;
7
- name: string;
8
- avatar: string;
9
- }
10
- export interface GetUserRequest {
11
- }
12
- export interface GetUserResponse {
13
- error: Error | undefined;
14
- user: User | undefined;
15
- }
16
- export interface UserService {
17
- GetUser(request: GetUserRequest, metadata?: Metadata): Observable<GetUserResponse>;
18
- }