|
| 1 | +// Copyright (c) 2026 Lark Technologies Pte. Ltd. |
| 2 | +// SPDX-License-Identifier: MIT |
| 3 | + |
| 4 | +// Package note owns the Note domain: querying note detail and the unified |
| 5 | +// transcript by a known note_id. The vc domain locates a |
| 6 | +// note_id from meeting context and delegates note-detail parsing here, so the |
| 7 | +// parsing logic lives in exactly one place. |
| 8 | +package note |
| 9 | + |
| 10 | +import ( |
| 11 | + "context" |
| 12 | + "encoding/json" |
| 13 | + "errors" |
| 14 | + "fmt" |
| 15 | + "net/http" |
| 16 | + "strconv" |
| 17 | + "strings" |
| 18 | + |
| 19 | + "github.com/larksuite/cli/errs" |
| 20 | + "github.com/larksuite/cli/internal/validate" |
| 21 | + "github.com/larksuite/cli/shortcuts/common" |
| 22 | +) |
| 23 | + |
| 24 | +// NoNoteReadPermissionCode is returned when the caller lacks read permission |
| 25 | +// for the requested note. |
| 26 | +const NoNoteReadPermissionCode = 121005 |
| 27 | + |
| 28 | +// ErrEmptyDetail identifies note detail responses that do not contain a note |
| 29 | +// object. Callers should use errors.Is instead of matching the display message. |
| 30 | +var ErrEmptyDetail = errors.New("note detail is empty") |
| 31 | + |
| 32 | +// artifact_type enum from the note detail API. |
| 33 | +const ( |
| 34 | + artifactTypeMainDoc = 1 // main note document |
| 35 | + artifactTypeVerbatim = 2 // verbatim transcript |
| 36 | +) |
| 37 | + |
| 38 | +// note_display_type enum (i32) from the note detail API. Surfaced to callers as |
| 39 | +// a stable string so Agents route on a name, not a magic number. |
| 40 | +const ( |
| 41 | + displayTypeNormal = 1 |
| 42 | + displayTypeUnified = 2 |
| 43 | +) |
| 44 | + |
| 45 | +// Detail is the parsed note detail shared by `note +detail` and `vc +notes`. |
| 46 | +type Detail struct { |
| 47 | + NoteID string |
| 48 | + CreatorID string |
| 49 | + CreateTime string |
| 50 | + DisplayType string // unknown | normal | unified |
| 51 | + NoteDocToken string |
| 52 | + VerbatimDocToken string |
| 53 | + SharedDocTokens []string |
| 54 | +} |
| 55 | + |
| 56 | +// FetchDetail queries GET /open-apis/vc/v1/notes/{note_id} and parses the note |
| 57 | +// object. API errors are returned as typed errs.* values so callers can enrich |
| 58 | +// user guidance without downgrading the envelope. |
| 59 | +func FetchDetail(_ context.Context, runtime *common.RuntimeContext, noteID string) (*Detail, error) { |
| 60 | + data, err := runtime.DoAPIJSONTyped(http.MethodGet, fmt.Sprintf("/open-apis/vc/v1/notes/%s", validate.EncodePathSegment(noteID)), nil, nil) |
| 61 | + if err != nil { |
| 62 | + return nil, err |
| 63 | + } |
| 64 | + noteObj, _ := data["note"].(map[string]any) |
| 65 | + if noteObj == nil { |
| 66 | + return nil, errs.NewInternalError(errs.SubtypeInvalidResponse, "note detail is empty").WithCause(ErrEmptyDetail) |
| 67 | + } |
| 68 | + noteDoc, verbatimDoc := extractArtifactTokens(common.GetSlice(noteObj, "artifacts")) |
| 69 | + return &Detail{ |
| 70 | + NoteID: noteID, |
| 71 | + CreatorID: common.GetString(noteObj, "creator_id"), |
| 72 | + CreateTime: common.FormatTime(noteObj["create_time"]), |
| 73 | + DisplayType: displayTypeString(displayTypeValue(noteObj)), |
| 74 | + NoteDocToken: noteDoc, |
| 75 | + VerbatimDocToken: verbatimDoc, |
| 76 | + SharedDocTokens: extractDocTokens(common.GetSlice(noteObj, "references")), |
| 77 | + }, nil |
| 78 | +} |
| 79 | + |
| 80 | +// ToMap renders the detail as the field map consumed by `vc +notes`, keeping |
| 81 | +// the historical key set (shared_doc_tokens omitted when empty) and adding the |
| 82 | +// note_id / note_display_type fields. |
| 83 | +func (d *Detail) ToMap() map[string]any { |
| 84 | + m := map[string]any{ |
| 85 | + "note_id": d.NoteID, |
| 86 | + "note_display_type": d.DisplayType, |
| 87 | + "creator_id": d.CreatorID, |
| 88 | + "create_time": d.CreateTime, |
| 89 | + "note_doc_token": d.NoteDocToken, |
| 90 | + "verbatim_doc_token": d.VerbatimDocToken, |
| 91 | + } |
| 92 | + if len(d.SharedDocTokens) > 0 { |
| 93 | + m["shared_doc_tokens"] = d.SharedDocTokens |
| 94 | + } |
| 95 | + return m |
| 96 | +} |
| 97 | + |
| 98 | +// displayTypeValue reads the display-type field, tolerating either the |
| 99 | +// documented note_display_type key or a bare display_type fallback. |
| 100 | +func displayTypeValue(note map[string]any) any { |
| 101 | + if v, ok := note["note_display_type"]; ok { |
| 102 | + return v |
| 103 | + } |
| 104 | + return note["display_type"] |
| 105 | +} |
| 106 | + |
| 107 | +func displayTypeString(v any) string { |
| 108 | + switch parseLooseInt(v) { |
| 109 | + case displayTypeNormal: |
| 110 | + return "normal" |
| 111 | + case displayTypeUnified: |
| 112 | + return "unified" |
| 113 | + default: |
| 114 | + return "unknown" |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +// extractArtifactTokens picks main-doc and verbatim-doc tokens from artifacts. |
| 119 | +func extractArtifactTokens(artifacts []any) (noteDoc, verbatimDoc string) { |
| 120 | + for _, a := range artifacts { |
| 121 | + artifact, _ := a.(map[string]any) |
| 122 | + if artifact == nil { |
| 123 | + continue |
| 124 | + } |
| 125 | + docToken, _ := artifact["doc_token"].(string) |
| 126 | + switch parseLooseInt(artifact["artifact_type"]) { |
| 127 | + case artifactTypeMainDoc: |
| 128 | + noteDoc = docToken |
| 129 | + case artifactTypeVerbatim: |
| 130 | + verbatimDoc = docToken |
| 131 | + } |
| 132 | + } |
| 133 | + return |
| 134 | +} |
| 135 | + |
| 136 | +// extractDocTokens collects doc_token values from a list of reference objects. |
| 137 | +func extractDocTokens(refs []any) []string { |
| 138 | + var tokens []string |
| 139 | + for _, s := range refs { |
| 140 | + source, _ := s.(map[string]any) |
| 141 | + if source == nil { |
| 142 | + continue |
| 143 | + } |
| 144 | + if docToken, _ := source["doc_token"].(string); docToken != "" { |
| 145 | + tokens = append(tokens, docToken) |
| 146 | + } |
| 147 | + } |
| 148 | + return tokens |
| 149 | +} |
| 150 | + |
| 151 | +// parseLooseInt extracts an int from the varying JSON number representations |
| 152 | +// DoAPIJSON may yield (json.Number, float64, or int). |
| 153 | +func parseLooseInt(v any) int { |
| 154 | + switch n := v.(type) { |
| 155 | + case json.Number: |
| 156 | + i, _ := n.Int64() |
| 157 | + return int(i) |
| 158 | + case float64: |
| 159 | + // Reject fractional values: truncating 1.9 to 1 would silently coerce |
| 160 | + // a malformed enum into a valid one. |
| 161 | + if n != float64(int64(n)) { |
| 162 | + return 0 |
| 163 | + } |
| 164 | + return int(n) |
| 165 | + case int: |
| 166 | + return n |
| 167 | + default: |
| 168 | + return 0 |
| 169 | + } |
| 170 | +} |
| 171 | + |
| 172 | +// parseLooseCursorID extracts a positive cursor as a string. String cursors are |
| 173 | +// preferred because large JSON numbers lose precision when decoded into any. |
| 174 | +func parseLooseCursorID(v any) (string, bool) { |
| 175 | + switch n := v.(type) { |
| 176 | + case string: |
| 177 | + s := strings.TrimSpace(n) |
| 178 | + if s == "" || s == "0" { |
| 179 | + return "", false |
| 180 | + } |
| 181 | + return s, true |
| 182 | + case json.Number: |
| 183 | + i, err := n.Int64() |
| 184 | + if err != nil || i <= 0 { |
| 185 | + return "", false |
| 186 | + } |
| 187 | + return strconv.FormatInt(i, 10), true |
| 188 | + case float64: |
| 189 | + // encoding/json decodes numbers in map[string]any as float64. Accept |
| 190 | + // only values that can round-trip safely as an integer cursor. |
| 191 | + const maxSafeJSONInteger = 1<<53 - 1 |
| 192 | + if n <= 0 || n != float64(int64(n)) || n > maxSafeJSONInteger { |
| 193 | + return "", false |
| 194 | + } |
| 195 | + return strconv.FormatInt(int64(n), 10), true |
| 196 | + case int64: |
| 197 | + if n <= 0 { |
| 198 | + return "", false |
| 199 | + } |
| 200 | + return strconv.FormatInt(n, 10), true |
| 201 | + case int: |
| 202 | + if n <= 0 { |
| 203 | + return "", false |
| 204 | + } |
| 205 | + return strconv.Itoa(n), true |
| 206 | + default: |
| 207 | + return "", false |
| 208 | + } |
| 209 | +} |
0 commit comments