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
|
import { docs_v1 } from "googleapis";
import { PostToServer } from "../../../Utils";
import { RouteStore } from "../../../server/RouteStore";
import { Opt } from "../../../new_fields/Doc";
import { isArray } from "util";
export namespace GoogleApiClientUtils {
export namespace Docs {
export enum Actions {
Create = "create",
Retrieve = "retrieve",
Update = "update"
}
export type DocumentId = string;
export type Reference = DocumentId | CreateOptions;
export type TextContent = string | string[];
export type IdHandler = (id: DocumentId) => any;
export type CreationResult = Opt<DocumentId>;
export type RetrievalResult = Opt<docs_v1.Schema$Document>;
export type UpdateResult = Opt<docs_v1.Schema$BatchUpdateDocumentResponse>;
export type ReadLinesResult = Opt<string[]>;
export type ReadResult = Opt<string>;
export interface CreateOptions {
handler: IdHandler; // callback to process the documentId of the newly created Google Doc
title?: string; // if excluded, will use a default title annotated with the current date
}
export interface RetrieveOptions {
documentId: DocumentId;
}
export type ReadOptions = RetrieveOptions & { removeNewlines?: boolean };
export interface WriteOptions {
content: TextContent;
reference: Reference;
index?: number; // if excluded, will compute the last index of the document and append the content there
}
export interface UpdateOptions {
documentId: DocumentId;
requests: docs_v1.Schema$Request[];
}
export namespace Utils {
export const extractText = (document: docs_v1.Schema$Document, removeNewlines = false): string => {
const fragments: string[] = [];
if (document.body && document.body.content) {
for (const element of document.body.content) {
if (element.paragraph && element.paragraph.elements) {
for (const inner of element.paragraph.elements) {
if (inner && inner.textRun) {
const fragment = inner.textRun.content;
fragment && fragments.push(fragment);
}
}
}
}
}
const text = fragments.join("");
return removeNewlines ? text.ReplaceAll("\n", "") : text;
};
export const endOf = (schema: docs_v1.Schema$Document): number | undefined => {
if (schema.body && schema.body.content) {
const paragraphs = schema.body.content.filter(el => el.paragraph);
if (paragraphs.length) {
const target = paragraphs[paragraphs.length - 1];
if (target.paragraph && target.paragraph.elements) {
length = target.paragraph.elements.length;
if (length) {
const final = target.paragraph.elements[length - 1];
return final.endIndex ? final.endIndex - 1 : undefined;
}
}
}
}
};
export const initialize = async (reference: Reference) => typeof reference === "string" ? reference : create(reference);
}
/**
* After following the authentication routine, which connects this API call to the current signed in account
* and grants the appropriate permissions, this function programmatically creates an arbitrary Google Doc which
* should appear in the user's Google Doc library instantaneously.
*
* @param options the title to assign to the new document, and the information necessary
* to store the new documentId returned from the creation process
* @returns the documentId of the newly generated document, or undefined if the creation process fails.
*/
export const create = async (options: CreateOptions): Promise<CreationResult> => {
const path = RouteStore.googleDocs + Actions.Create;
const parameters = {
requestBody: {
title: options.title || `Dash Export (${new Date().toDateString()})`
}
};
try {
const schema: docs_v1.Schema$Document = await PostToServer(path, parameters);
const generatedId = schema.documentId;
if (generatedId) {
options.handler(generatedId);
return generatedId;
}
} catch {
return undefined;
}
};
export const retrieve = async (options: RetrieveOptions): Promise<RetrievalResult> => {
const path = RouteStore.googleDocs + Actions.Retrieve;
try {
const schema: RetrievalResult = await PostToServer(path, options);
return schema;
} catch {
return undefined;
}
};
export const update = async (options: UpdateOptions): Promise<UpdateResult> => {
const path = RouteStore.googleDocs + Actions.Update;
const parameters = {
documentId: options.documentId,
requestBody: {
requests: options.requests
}
};
try {
const replies: UpdateResult = await PostToServer(path, parameters);
return replies;
} catch {
return undefined;
}
};
export const read = async (options: ReadOptions): Promise<ReadResult> => {
return retrieve(options).then(schema => {
return schema ? Utils.extractText(schema, options.removeNewlines) : undefined;
});
};
export const readLines = async (options: ReadOptions): Promise<ReadLinesResult> => {
return retrieve(options).then(schema => {
if (!schema) {
return undefined;
}
const lines = Utils.extractText(schema).split("\n");
return options.removeNewlines ? lines.filter(line => line.length) : lines;
});
};
export const write = async (options: WriteOptions): Promise<UpdateResult> => {
const documentId = await Utils.initialize(options.reference);
if (!documentId) {
return undefined;
}
let index = options.index;
if (!index) {
let schema = await retrieve({ documentId });
if (!schema || !(index = Utils.endOf(schema))) {
return undefined;
}
}
const text = options.content;
const updateOptions = {
documentId,
requests: [{
insertText: {
text: isArray(text) ? text.join("\n") : text,
location: { index }
}
}]
};
return update(updateOptions);
};
}
}
|
