-
Notifications
You must be signed in to change notification settings - Fork 0
/
sheet_origin.go
501 lines (457 loc) · 16.8 KB
/
sheet_origin.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/*
SpreadSheetOrigin provide the API of the feihsu/lark open API document.
SpreadSheet provide the combinatorial API of SpreadSheetOrigin.
*/
package docs
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"strings"
"github.com/hilaily/kit/netx"
"github.com/hilaily/kit/stringx"
)
func newSpreadSheetOrigin(client *Client, token string) *SpreadSheetOrigin {
return &SpreadSheetOrigin{
baseClient: client,
token: token,
}
}
// SpreadSheetOrigin represent for origin open API.
// 这个客户端的方法使用了原始的开放平台 API,没有做任何封装。
type SpreadSheetOrigin struct {
baseClient *Client
token string
}
// MetaInfo
// api: /open-apis/sheet/v2/spreadsheets/:spreadsheetToken/metainfo
// reference: https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN
func (so *SpreadSheetOrigin) MetaInfo() (b []byte, result *MetaInfoResp, err error) {
url := so.baseClient.urlJoin("/open-apis/sheet/v2/spreadsheets/", so.token, "metainfo")
_req, _ := http.NewRequest(http.MethodGet, url, nil)
b, err = so.baseClient.CommonReq(_req, &result)
return
}
// Properties
// reference: https://open.feishu.cn/document/ukTMukTMukTM/ucTMzUjL3EzM14yNxMTN
func (so *SpreadSheetOrigin) Properties(prop *SpreadSheetProperties) (b []byte, err error) {
en, _ := json.Marshal(map[string]*SpreadSheetProperties{
"properties": prop,
})
req, _ := http.NewRequest(
http.MethodPut,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/properties"),
bytes.NewReader(en),
)
b, err = so.baseClient.CommonReq(req, nil)
return
}
// SheetBatchUpdate for update properties of a sheet
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uQDO2UjL0gjN14CN4YTN
// 更新 sheet 的属性
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/ugjMzUjL4IzM14COyMTN
func (so *SpreadSheetOrigin) SheetBatchUpdate(args map[ModifySheetType]interface{}) (b []byte, resp *SheetBatchUpdateResp, err error) {
argsArr := make([]interface{}, 0, 1)
for k := range args {
argsArr = append(argsArr, map[ModifySheetType]interface{}{
k: args[k],
})
}
en, _ := json.Marshal(map[string][]interface{}{
"requests": argsArr,
})
resp = &SheetBatchUpdateResp{}
_req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "open-apis/sheet/v2/spreadsheets/", so.token, "/sheets_batch_update"),
bytes.NewReader(en))
b, err = so.baseClient.CommonReq(_req, resp)
return
}
// Import represent import excel from local
// reference https://open.larksuite.com/document/ukTMukTMukTM/uATO2YjLwkjN24CM5YjN
func (so *SpreadSheetOrigin) Import(filepath string, filename string, folderToken string) ([]byte, string, error) {
data, err := ioutil.ReadFile(filepath)
if err != nil {
return nil, "", err
}
en, _ := json.Marshal(
map[string]interface{}{
"file": data,
"name": filename,
"folderToken": folderToken,
},
)
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheets/v2/import"),
bytes.NewReader(en),
)
resp := &struct {
Ticket string `json:"ticket"`
}{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp.Ticket, err
}
// ValuesPrepend
// reference https://open.feishu.cn/document/ukTMukTMukTM/uIjMzUjLyIzM14iMyMTN
func (so *SpreadSheetOrigin) ValuesPrepend(_range SheetRange, data [][]interface{}) ([]byte, *ValuesPrependResp, error) {
en, _ := json.Marshal(map[string]interface{}{
"valueRange": map[string]interface{}{
"range": _range,
"values": data,
},
})
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "values_prepend"),
bytes.NewReader(en),
)
resp := &ValuesPrependResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
// ValuesAppend
// reference https://open.feishu.cn/document/ukTMukTMukTM/uMjMzUjLzIzM14yMyMTN
func (so *SpreadSheetOrigin) ValuesAppend(_range Range, data [][]interface{}, inseartDataOption InseartDataOptionType) ([]byte, *ValuesPrependResp, error) {
en, _ := json.Marshal(map[string]interface{}{
"valueRange": map[string]interface{}{
"range": _range,
"values": data,
},
})
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/values_prepend?insertDataOption="+inseartDataOption),
bytes.NewReader(en),
)
resp := &ValuesPrependResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
func (so *SpreadSheetOrigin) InsertDimensionRange(sheetID string, startIndex, endIndex int, majorDimension MajorDimensionType, inheritStyle InheritStyleType) error {
en, _ := json.Marshal(map[string]interface{}{
"dimension": map[string]interface{}{
"sheetId": sheetID,
"majorDimension": majorDimension,
"startIndex": startIndex,
"endIndex": endIndex,
},
"inheritStyle": inheritStyle,
})
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/insert_dimension_range"),
bytes.NewReader(en),
)
_, err := so.baseClient.CommonReq(req, nil)
return err
}
func (so *SpreadSheetOrigin) DimensionRangePost(sheetID string, majorDimension MajorDimensionType, length int) ([]byte, *DimensionRangeResp, error) {
en, _ := json.Marshal(map[string]interface{}{
"dimension": map[string]interface{}{
"sheetId": sheetID,
"majorDimension": majorDimension,
"length": length,
},
})
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/dimension_range"),
bytes.NewReader(en),
)
resp := &DimensionRangeResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
// DimensionRangePut for update rows or columns
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uETO2UjLxkjN14SM5YTN
// 更新行列
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/uYjMzUjL2IzM14iNyMTN
func (so *SpreadSheetOrigin) DimensionRangePut(sheetID string, majorDimension MajorDimensionType, startIndex, endIndex int, visible bool, fixedSize int) ([]byte, *DimensionRangePutResp, error) {
en, _ := json.Marshal(map[string]map[string]interface{}{
"dimension": {
"sheetId": sheetID,
"majorDimension": majorDimension,
"startIndex": startIndex,
"endIndex": endIndex,
},
"dimensionProperties": {
"visible": visible,
"fixedSize": fixedSize,
},
})
req, _ := http.NewRequest(
http.MethodPut,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/dimension_range"),
bytes.NewReader(en),
)
b, err := so.baseClient.CommonReq(req, nil)
return b, nil, err
}
// DimensionRangeDelete for delete rows or columns
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uATO2UjLwkjN14CM5YTN
// 删除行列
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/ucjMzUjL3IzM14yNyMTN
func (so *SpreadSheetOrigin) DimensionRangeDelete(sheetID string, majorDimension MajorDimensionType, startIndex, endIndex int) ([]byte, *DimensionRangeDeleteResp, error) {
en, _ := json.Marshal(map[string]map[string]interface{}{
"dimension": {
"sheetId": sheetID,
"majorDimension": majorDimension,
"startIndex": startIndex,
"endIndex": endIndex,
},
})
req, _ := http.NewRequest(
http.MethodDelete,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheet/v2/spreadsheets/", so.token, "/dimension_range"),
bytes.NewReader(en),
)
resp := &DimensionRangeDeleteResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
// ReadValuesByRange read data by range
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/ukzN2UjL5cjN14SO3YTN
// 读取单个范围的数据
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN
func (so *SpreadSheetOrigin) ReadValuesByRange(_range Range, valueRender string, dateTimeRender string) ([]byte, *GetValuesByRangeResp, error) {
u := so.baseClient.urlJoin("open-apis/sheet/v2/spreadsheets/", so.token, "/values/", _range)
p := map[string]string{}
if valueRender != "" {
p["valueRenderOption"] = valueRender
}
if dateTimeRender != "" {
p["dateTimeRenderOption"] = dateTimeRender
}
u, _ = netx.URLQueryParams(u, p)
_req, _ := http.NewRequest(http.MethodGet, u, nil)
resp := &GetValuesByRangeResp{}
b, err := so.baseClient.CommonReq(_req, resp)
return b, resp, err
}
// WriteValuesByRange for writing data to a single range
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uMDO2UjLzgjN14yM4YTN
// 向单个范围写入数据
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/uAjMzUjLwIzM14CMyMTN
func (so *SpreadSheetOrigin) WriteValuesByRange(_range Range, data [][]interface{}) ([]byte, *WriteValuesByRangeResp, error) {
en, _ := json.Marshal(map[string]map[string]interface{}{
"valueRange": {
"range": _range,
"values": data,
},
})
req, _ := http.NewRequest(
http.MethodPut,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheets/v2/spreadsheets/", so.token, "/values"),
bytes.NewReader(en),
)
resp := &WriteValuesByRangeResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
// ReadValuesByRangeMulti for reading multiple ranges
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uADO2UjLwgjN14CM4YTN
// 读取多个范围的数据
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/ukTMzUjL5EzM14SOxMTN
func (so *SpreadSheetOrigin) ReadValuesByRangeMulti(ranges []Range, valueRender string, dateTimeRender string) ([]byte, *GetValuesByRangeMultiResp, error) {
u := so.baseClient.urlJoin("open-apis/sheet/v2/spreadsheets/", so.token, "/values_batch_get/")
p := map[string]string{
"ranges": strings.Join(ranges, ","),
}
if valueRender != "" {
p["valueRenderOption"] = valueRender
}
if dateTimeRender != "" {
p["dateTimeRenderOption"] = dateTimeRender
}
u, _ = netx.URLQueryParams(u, p)
_req, _ := http.NewRequest(http.MethodGet, u, nil)
resp := &GetValuesByRangeMultiResp{}
b, err := so.baseClient.CommonReq(_req, resp)
return b, resp, err
}
// WriteValuesByRangeMulti for writing data to multiple ranges
// reference https://open.larksuite.com/document/uMzMyEjLzMjMx4yMzITM/uIDO2UjLygjN14iM4YTN
// 向多个范围写入数据
// 参考 https://open.feishu.cn/document/ukTMukTMukTM/uEjMzUjLxIzM14SMyMTN
func (so *SpreadSheetOrigin) WriteValuesByRangeMulti(rangeDatas []*WriteValuesByRangeMultiArgs) ([]byte, *WriteValuesByRangeMultiResp, error) {
en, _ := json.Marshal(map[string]interface{}{
"valueRanges": rangeDatas,
})
req, _ := http.NewRequest(
http.MethodPost,
stringx.URLJoin(so.baseClient.domain, "/open-apis/sheets/v2/spreadsheets/", so.token, "values_batch_update"),
bytes.NewReader(en),
)
resp := &WriteValuesByRangeMultiResp{}
b, err := so.baseClient.CommonReq(req, resp)
return b, resp, err
}
// Style ...
func (so *SpreadSheetOrigin) Style(_range Range, style *SheetCellStyle) (*SheetStyleResp, error) {
u := so.baseClient.urlJoin("/open-apis/sheets/v2/spreadsheets/" + so.token + "/style")
en, _ := json.Marshal(map[string]interface{}{
"appendStyle": map[string]interface{}{
"range": _range,
"style": style,
},
})
req, _ := http.NewRequest(http.MethodPut,
u,
bytes.NewReader(en),
)
r := &SheetStyleResp{}
_, err := so.baseClient.CommonReq(req, r)
if err != nil {
return nil, fmt.Errorf("set style fail %w", err)
}
return r, nil
}
type SpreadSheetProperties struct {
Title *string `json:"title,omitempty"`
}
type ValuesPrependResp struct {
Revision int `json:"revision"`
SpreadsheetToken string `json:"spreadsheetToken"`
TableRange string `json:"tableRange"`
Updates ValuesPrependUpdates `json:"updates"`
}
type ValuesPrependUpdates struct {
SpreadsheetToken string `json:"spreadsheetToken"`
UpdatedRange string `json:"updatedRange"`
UpdatedRows int `json:"updatedRows"`
UpdatedColumns int `json:"updatedColumns"`
UpdatedCells int `json:"updatedCells"`
Revision int `json:"revision"`
}
type DimensionRangeResp struct {
AddCount int `json:"addCount"`
MajorDimension string `json:"majorDimension"`
}
type (
SheetBatchUpdateResp struct {
Replies []SheetBatchUpdateRespReplies `json:"replies"`
}
SheetBatchUpdateRespReplies struct {
AddSheet SheetBatchUpdateRespAddSheet `json:"addSheet"`
CopySheet SheetBatchUpdateRespCopySheet `json:"copySheet"`
UpdateSheet SheetBatchUpdateRespUpdateSheet `json:"updateSheet"`
DeleteSheet SheetBatchUpdateRespDeleteSheet `json:"deleteSheet"`
}
SheetBatchUpdateRespProperties struct {
SheetID string `json:"sheetId"`
Title string `json:"title"`
Index int `json:"index"`
}
SheetBatchUpdateRespAddSheet struct {
Properties SheetBatchUpdateRespProperties `json:"properties"`
}
SheetBatchUpdateRespCopySheet struct {
Properties SheetBatchUpdateRespProperties `json:"properties"`
}
SheetBatchUpdateRespDeleteSheet struct {
Result bool `json:"result"`
SheetID string `json:"sheetId"`
}
SheetBatchUpdateRespUpdateSheet struct {
UpdateSheet SheetBatchUpdateRespUpdateSheetUpdateSheet `json:"updateSheet"`
}
SheetBatchUpdateRespUpdateSheetProtect struct {
Lock string `json:"lock"`
SheetName string `json:"sheetName"`
PermID string `json:"permId"`
UserIds []int64 `json:"userIds"`
}
SheetBatchUpdateRespUpdateSheetProperties struct {
SheetID string `json:"sheetId"`
Title string `json:"title"`
Index int `json:"index"`
Hidden bool `json:"hidden"`
FrozenColCount int `json:"frozenColCount"`
FrozenRowCount int `json:"frozenRowCount"`
Protect SheetBatchUpdateRespUpdateSheetProtect `json:"protect"`
}
SheetBatchUpdateRespUpdateSheetUpdateSheet struct {
Properties SheetBatchUpdateRespUpdateSheetProperties `json:"properties"`
}
)
type (
DimensionRangePutResp = interface{} // there is no document, for future use.
)
type (
DimensionRangeDeleteResp struct {
DelCount int `json:"delCount"`
MajorDimension MajorDimensionType `json:"majorDimension"`
}
)
type (
GetValuesByRangeResp struct {
Revision int `json:"revision"`
SpreadsheetToken string `json:"spreadsheetToken"`
ValueRange GetValuesByRangeRespValueRange `json:"valueRange"`
}
GetValuesByRangeRespValueRange struct {
MajorDimension string `json:"majorDimension"`
Range string `json:"range"`
Revision int `json:"revision"`
Values [][]interface{} `json:"values"`
}
)
type (
GetValuesByRangeMultiResp struct {
Revision int `json:"revision"`
SpreadsheetToken string `json:"spreadsheetToken"`
TotalCells int `json:"totalCells"`
ValueRanges []GetValuesByRangeMultiRespValueRanges `json:"valueRanges"`
}
GetValuesByRangeMultiRespValueRanges struct {
MajorDimension string `json:"majorDimension"`
Range string `json:"range"`
Revision int `json:"revision"`
Values [][]interface{} `json:"values"`
}
)
type (
WriteValuesByRangeResp struct {
Revision int `json:"revision"`
SpreadsheetToken string `json:"spreadsheetToken"`
UpdatedCells int `json:"updatedCells"`
UpdatedColumns int `json:"updatedColumns"`
UpdatedRange string `json:"updatedRange"`
UpdatedRows int `json:"updatedRows"`
}
)
type (
WriteValuesByRangeMultiArgs struct {
Range Range `json:"range"`
Values [][]interface{} `json:"values"`
}
WriteValuesByRangeMultiResp struct {
Responses []WriteValuesByRangeMultiRespResponses `json:"responses"`
Revision int `json:"revision"`
SpreadsheetToken string `json:"spreadsheetToken"`
}
WriteValuesByRangeMultiRespResponses struct {
SpreadsheetToken string `json:"spreadsheetToken"`
UpdatedCells int `json:"updatedCells"`
UpdatedColumns int `json:"updatedColumns"`
UpdatedRange string `json:"updatedRange"`
UpdatedRows int `json:"updatedRows"`
}
)
type (
SheetStyleResp struct {
Updates SheetStyleRespUpdate `json:"updates"`
}
SheetStyleRespUpdate struct {
SpreadsheetToken string `json:"spreadsheetToken"`
UpdatedRange string `json:"updatedRange"`
UpdatedRows int `json:"updatedRows"`
UpdatedColumns int `json:"updatedColumns"`
UpdatedCells int `json:"updatedCells"`
Revision int `json:"revision"`
}
)