Class GoogleSheets

Google Sheets backend.

Hierarchy (view full)

Google
- GoogleSheets

Constructors

constructor

new GoogleSheets(url, o?): GoogleSheets
Parameters
- url: string
  URL string describing the data location
- o: any = {}
  Options
Returns GoogleSheets
Inherited from Google.constructor
- Defined in src/oauth-backend.js:16

Properties

accessToken

accessToken: any

apiKey

apiKey: any

authPopup

authPopup: Window

clientId

clientId: any

data

data: any

options

options: any

permissions

permissions: any

rawData

rawData: string

ready

ready: Promise<void>

ref

ref: any

source

source: string

spreadsheet

spreadsheet: any

user

user: any

`Static` _all

_all: any[] = []

`Static` apiDomain

apiDomain: string = "https://sheets.googleapis.com/v4/spreadsheets/"

`Static` authProvider

authProvider: string = "https://auth.madata.dev"

Auth Provider to use. This is only relevant for OAuthBackend, but specifying here as Backend is the only class users import.

`Static` capabilities

capabilities: {
auth: boolean;
put: boolean;
} = ...

Type declaration

auth: boolean
put: boolean

`Static` defaultFormat

defaultFormat: string = "JSON"

`Static` defaultPermissions

defaultPermissions: {
read: boolean;
} = ...

Type declaration

read: boolean

`Static` hooks

hooks: Hooks = hooks

`Static` oAuth

oAuth: string = "https://accounts.google.com/o/oauth2/auth"

`Static` phrases

phrases: {
    get_no_sheet: string;
    get_no_sheet_or_invalid_range: ((sheet, range, sheetIndex) => string);
    get_no_spreadsheet: ((url) => string);
    store_no_sheet: ((sheet) => string);
    store_sheet_added: ((sheet) => string);
} = ...

Type declaration

get_no_sheet: string
get_no_sheet_or_invalid_range: ((sheet, range, sheetIndex) => string)
- - (sheet, range, sheetIndex): string
  - Parameters
    - sheet: any
    - range: any
    - sheetIndex: any
    Returns string
get_no_spreadsheet: ((url) => string)
- - (url): string
  - Parameters
    - url: any
    Returns string
store_no_sheet: ((sheet) => string)
- - (sheet): string
  - Parameters
    - sheet: any
    Returns string
store_sheet_added: ((sheet) => string)
- - (sheet): string
  - Parameters
    - sheet: any
    Returns string

`Static` scopes

scopes: string[] = ...

`Static` urls

urls: {
    hash: string;
    hostname: string;
    pathname: string;
}[] = ...

Type declaration

hash: string
hostname: string
pathname: string

`Static` useCache

useCache: boolean = false

`Static` userCall

userCall: string = "https://www.googleapis.com/oauth2/v2/userinfo"

`Static` userSchema

userSchema: {
    avatar: string[];
    name: string[];
    username: string;
} = ...

Type declaration

avatar: string[]
name: string[]
username: string

Accessors

`Static` all

get all(): any[]
Returns any[]
Inherited from Google.all
- Defined in src/backend.js:353

`Static` authProviderServices

get authProviderServices(): Promise<any>
services.json from the auth provider will be cached here. You could also set this manually to avoid the network request.

Returns Promise<any>
Member
Inherited from Google.authProviderServices
- Defined in src/backend.js:415

`Static` host

get host(): any
Return the hostname of the first URL pattern in the urls array, if not variable. This is used to facilitate relative URLs when constructing Backends directly. Subclasses with variable hostnames can override this.

Returns any
Inherited from Google.host
- Defined in src/backend.js:266

`Static` oAuthParams

get oAuthParams(): string
Returns string
Inherited from Google.oAuthParams
- Defined in backends/google/google.js:17

`Static` title

get title(): string
Returns string
Inherited from Google.title
- Defined in src/backend.js:31

`Static` tokenKey

get tokenKey(): string
Returns string
Inherited from Google.tokenKey
- Defined in src/oauth-backend.js:308

Methods

`Private` #getFormat

#getFormat(ref): any
Parameters
- ref: any
Returns any
Inherited from Google.#getFormat
- Defined in src/backend.js:89

`Private` #getSheetTitle

#getSheetTitle(ref?): Promise<any>
Get title of the sheet in the spreadsheet.
Parameters
- ref: any = ...
  Spreadsheet to work with.
Returns Promise<any>
Sheet title or title of the first visible sheet, or null if there are no (visible) sheets to work with.
- Defined in backends/google/sheets/google-sheets.js:307

_getRef

_getRef(ref): any
Parameters
- ref: any
Returns any
Inherited from Google._getRef
- Defined in src/backend.js:162

activeLogin

activeLogin(o): Promise<any>
Abstract
Show authentication UI to the user. Must be implemented by subclasses.
Parameters
- o: any
Returns Promise<any>
Inherited from Google.activeLogin
- Defined in src/oauth-backend.js:222

deleteLocalUserInfo

deleteLocalUserInfo(): void
Delete access token from local storage

Returns void
Inherited from Google.deleteLocalUserInfo
- Defined in src/oauth-backend.js:302

equals

equals(backend): boolean
Parameters
- backend: any
Returns boolean
Inherited from Google.equals
- Defined in src/backend.js:253

get

get(ref?, o?): any
Read data from the spreadsheet.
Parameters
- ref: string = ...
  Spreadsheet to work with.
- o: any = {}
  Arbitrary options.
Returns any
Spreadsheet data.
Overrides Google.get
- Defined in backends/google/sheets/google-sheets.js:16

getUser

getUser(): Promise<any>
Get info about the current user, if logged in. Subclasses are generally expected to override this.

Returns Promise<any>
- User info
Inherited from Google.getUser
- Defined in src/auth-backend.js:40

getUserIfValid

getUserIfValid(): Promise<any>
Returns Promise<any>
Inherited from Google.getUserIfValid
- Defined in src/oauth-backend.js:200

isAuthenticated

isAuthenticated(): boolean
Is current user authenticated? Synchronous because it must not trigger any API calls, use passiveLogin() for that

Returns boolean
Inherited from Google.isAuthenticated
- Defined in src/oauth-backend.js:54

load

load(url, ...args): any
Higher-level method for reading data from the backend. Subclasses should usually NOT override this method.
Parameters
- url: string
  URL to fetch, if different from that provided in the constructor
- Rest ...args: any[]
Returns any
- Data from the backend as a JSON object, null if not found
Inherited from Google.load
- Defined in src/backend.js:185

login

login(...args): Promise<any>
Helper method for authenticating in OAuth APIs
Parameters
- Rest ...args: any[]
  {object}
Returns Promise<any>
Overrides Google.login
- Defined in backends/google/sheets/google-sheets.js:260

logout

logout(): Promise<void>
oAuth logout helper

Returns Promise<void>
Inherited from Google.logout
- Defined in src/oauth-backend.js:276

parse

parse(data): any
Parameters
- data: any
Returns any
Overrides Google.parse
- Defined in backends/google/sheets/google-sheets.js:271

passiveLogin

passiveLogin(): Promise<void>
Abstract
Try to authenticate a previously authenticated user (i.e. without showing any login UI).

Returns Promise<void>
Inherited from Google.passiveLogin
- Defined in src/oauth-backend.js:269

put

put(data, __namedParameters?): Promise<any>
Save data to the spreadsheet.
Parameters
- data: any
  Data to save.
- __namedParameters: any = {}
Returns Promise<any>
- Defined in backends/google/sheets/google-sheets.js:127

remove

remove(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
Inherited from Google.remove
- Defined in src/backend.js:237

request

request(call, data?, method?, req?): Promise<any>
Helper for making OAuth requests with JSON-based APIs.
Parameters
- call: string
  API endpoint
- Optional data: any
  Data to send with the request
- Optional method: string = "GET"
  HTTP method
- Optional req: {
  headers: any;
  responseType: string;
  } = {}
  Extra request options
  - headers: any
    Extra headers
  - responseType: string
    Response type
Returns Promise<any>
- JSON response
Inherited from Google.request
- Defined in src/oauth-backend.js:73

store

store(data, o?): any
Higher-level method for writing data to the backend. Subclasses should usually NOT override this method.
Parameters
- data: any
  Data to write to the backend
- Optional o: any = {}
  Options object
Returns any
- If successful, info about the stored data
Inherited from Google.store
- Defined in src/backend.js:223

storeLocalUserInfo

storeLocalUserInfo(param0): Promise<void>
Store access token in local storage
Parameters
- param0: any
Returns Promise<void>
Inherited from Google.storeLocalUserInfo
- Defined in src/oauth-backend.js:295

stringify

stringify(data): any
Parameters
- data: any
Returns any
Overrides Google.stringify
- Defined in backends/google/sheets/google-sheets.js:270

syncWith

syncWith(backend): void
Sync the logged in user, i.e. log in passively when another backend has logged in and log out when another backend has logged out. Generally intended to be used for backends with the same authentication mechanism. Syncing is not two-way, you need to call this on the other backend as well to make it so.
Parameters
- backend: AuthBackend
Returns void
Inherited from Google.syncWith
- Defined in src/auth-backend.js:179

toString

toString(): string
Returns string
Inherited from Google.toString
- Defined in src/backend.js:249

update

update(url, o): void
Update an existing backend instance with new parameters
Parameters
- url: string
  Same as constructor
- o: any
  Same as constructor
Returns void
Inherited from Google.update
- Defined in src/oauth-backend.js:39

updatePermissions

updatePermissions(o): void
Parameters
- o: any
Returns void
Inherited from Google.updatePermissions
- Defined in src/backend.js:119

`Static` `Private` #fromObjects

#fromObjects(keys, values): any[][]
Transform an array of objects to an array of arrays.
Parameters
- keys: Map<string, string>
  A map between column indices and object keys.
- values: any[]
  An array of objects. Each object corresponds to an individual spreadsheet row.
Returns any[][]
An array of arrays. Each nested array corresponds to an individual spreadsheet row.
- Defined in backends/google/sheets/google-sheets.js:353

`Static` `Private` #getRangeReference

#getRangeReference(__namedParameters?): string
Get the range reference.
Parameters
- __namedParameters: string = {}
Returns string
The range reference in one of the supported formats: 'Sheet title'!Range, 'Sheet title', or Range.
- Defined in backends/google/sheets/google-sheets.js:298

`Static` `Private` #toObjects

#toObjects(keys, values): any[]
Transform an array of arrays to an array of objects.
Parameters
- keys: Map<string, string>
  A map between column indices and object keys.
- values: any[][]
  An array of values from a spreadsheet. Each nested array corresponds to an individual spreadsheet row.
Returns any[]
An array of objects. Each object corresponds to an individual spreadsheet row.
- Defined in backends/google/sheets/google-sheets.js:388

`Static` find

find(url, o): any
Parameters
- url: any
- o: any
Returns any
Inherited from Google.find
- Defined in src/backend.js:361

`Static` from

from(url, o?): any
Return the appropriate backend(s) for this url
Parameters
- url: string
  URL describing the storage location
- Optional o: {
  existing: Backend | Backend[];
  } = {}
  Options object to be passed to the backend
  - existing: Backend | Backend[]
    Existing backend object(s) to re-use if possible
Returns any
Inherited from Google.from
- Defined in src/backend.js:305

`Static` getOAuthBackend

getOAuthBackend(): any
Returns any
Inherited from Google.getOAuthBackend
- Defined in src/oauth-backend.js:136

`Static` keys

keys(header, index, headers): string
Get an object key taking into account that there might be duplicates among column headers.
Parameters
- header: string
  Header text.
- index: number
  Column index (zero-based).
- headers: [string]
  Array of column headers.
Returns string
Object key.
- Defined in backends/google/sheets/google-sheets.js:280

`Static` load

load(url, o): Promise<any>
Parameters
- url: any
- o: any
Returns Promise<any>
Inherited from Google.load
- Defined in src/backend.js:339

`Static` parseURL

parseURL(source): any
Parse spreadsheets URLs.
Parameters
- source: string
  Spreadsheet URL.
Returns any
Spreadsheet ID, sheet ID, sheet title, range.
Overrides Google.parseURL
- Defined in backends/google/sheets/google-sheets.js:417

`Static` phrase

phrase(id, ...args): string
Parameters
- id: any
- Rest ...args: any[]
Returns string
Inherited from Google.phrase
- Defined in src/backend.js:400

`Static` register

register(Class): any
Parameters
- Class: any
Returns any
Inherited from Google.register
- Defined in src/backend.js:377

`Static` test

test(source): boolean
Parameters
- source: any
Returns boolean
Inherited from Google.test
- Defined in src/backend.js:257

Class GoogleSheets

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

o: any = {}

Returns GoogleSheets

Properties

accessToken

apiKey

authPopup

clientId

data

options

permissions

rawData

ready

ref

source

spreadsheet

user

Static _all

Static apiDomain

Static authProvider

Static capabilities

Type declaration

auth: boolean

put: boolean

Static defaultFormat

Static defaultPermissions

Type declaration

read: boolean

Static hooks

Static oAuth

Static phrases

Type declaration

get_no_sheet: string

get_no_sheet_or_invalid_range: ((sheet, range, sheetIndex) => string)

Parameters

sheet: any

range: any

sheetIndex: any

Returns string

get_no_spreadsheet: ((url) => string)

Parameters

url: any

Returns string

store_no_sheet: ((sheet) => string)

Parameters

sheet: any

Returns string

store_sheet_added: ((sheet) => string)

Parameters

sheet: any

Returns string

Static scopes

Static urls

Type declaration

hash: string

hostname: string

pathname: string

Static useCache

Static userCall

Static userSchema

Type declaration

avatar: string[]

name: string[]

username: string

Accessors

Static all

Returns any[]

Static authProviderServices

Returns Promise<any>

Member

`Static` _all

`Static` apiDomain

`Static` authProvider

`Static` capabilities

`Static` defaultFormat

`Static` defaultPermissions

`Static` hooks

`Static` oAuth

`Static` phrases

`Static` scopes

`Static` urls

`Static` useCache

`Static` userCall

`Static` userSchema

`Static` all

`Static` authProviderServices

`Static` host

`Static` oAuthParams

`Static` title

`Static` tokenKey

`Private` #getFormat

`Private` #getSheetTitle

`Rest` ...args: any[]

`Rest` ...args: any[]