@sequencemedia/drive 0.0.112 → 0.0.113

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/drive",
-  "version": "0.0.112",
+  "version": "0.0.113",
   "main": "./src/index.mjs",
   "type": "module",
   "types": "./src/index.d.mts",
@@ -21,8 +21,8 @@
     "nconf": "^0.13.0"
   },
   "devDependencies": {
-    "@sequencemedia/eslint-config-standard": "^0.2.56",
-    "@sequencemedia/eslint-config-typescript": "^0.1.88",
+    "@sequencemedia/eslint-config-standard": "^0.2.57",
+    "@sequencemedia/eslint-config-typescript": "^0.1.89",
     "@types/debug": "^4.1.12",
     "@types/nconf": "^0.10.7",
     "@types/node": "^22.15.17",

package/src/common/authorize.d.mts

@@ -5,6 +5,6 @@ export function getClientEmail (keyFile: KeyFileType): string | null
 export function getPrivateKey (keyFile: KeyFileType): string | null
 
 /**
- * Authorise using a Service Account (and return a JWT client)
+ *  Authorise using a Service Account (and return a JWT client)
  */
 export default function authorize (keyFile: KeyFileType, scopes?: string[]): Promise<JWT>

package/src/common/authorize.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('google-auth-library').JWT} JWT
+ *  @typedef {import('google-auth-library').JWT} JWT
  */
 
 import {
@@ -19,11 +19,11 @@ export function getPrivateKey ({
 }
 
 /**
- * Authorise using a Service Account (and return a JWT client)
+ *  Authorise using a Service Account (and return a JWT client)
  *
- * @param {Record<PropertyKey, string | undefined>} keyFile
- * @param {string[]} scopes
- * @returns {JWT}
+ *  @param {Record<PropertyKey, string | undefined>} keyFile
+ *  @param {string[]} scopes
+ *  @returns {JWT}
  */
 export default async function authorize (keyFile, scopes = []) {
   if (!keyFile) throw new Error('A key file is required')

package/src/common/getKeyFile.d.mts

@@ -4,9 +4,9 @@ import {
 } from '#common/config'
 
 /**
- * @param {string | undefined | null} keyFileJson
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<KeyFileType>}
+ *  @param {string | undefined | null} keyFileJson
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<KeyFileType>}
  */
 export default function getKeyFile (keyFileJson: string | undefined | null, keyFilePath: string | undefined | null): Promise<KeyFileType>
 

package/src/common/getKeyFile.mjs

@@ -16,9 +16,9 @@ export {
 }
 
 /**
- * @param {string | undefined | null} keyFileJson
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<Record<PropertyKey, string | undefined>>}
+ *  @param {string | undefined | null} keyFileJson
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<Record<PropertyKey, string | undefined>>}
  */
 export default async function getKeyFile (keyFileJson, keyFilePath) {
   if (hasKeyFileJson(keyFileJson)) {

package/src/common/hasKeyFile.d.mts

@@ -4,9 +4,9 @@ import {
 } from '#common/config'
 
 /**
- * @param {string | undefined | null} keyFileJson
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<boolean>}
+ *  @param {string | undefined | null} keyFileJson
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<boolean>}
  */
 export default function hasKeyFile (keyFileJson: string | undefined | null, keyFilePath: string | undefined | null): Promise<boolean>
 

package/src/common/hasKeyFile.mjs

@@ -12,9 +12,9 @@ export {
 }
 
 /**
- * @param {string | undefined | null} keyFileJson
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<boolean>}
+ *  @param {string | undefined | null} keyFileJson
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<boolean>}
  */
 export default async function hasKeyFile (keyFileJson, keyFilePath) {
   try {

package/src/common/hasKeyFileJson.d.mts

@@ -1,5 +1,5 @@
 /**
- * @param {string | undefined | null} keyFileJson
- * @returns {boolean}
+ *  @param {string | undefined | null} keyFileJson
+ *  @returns {boolean}
  */
 export default function hasKeyFileJson (keyFileJson: string | undefined | null): boolean

package/src/common/hasKeyFileJson.mjs

@@ -1,6 +1,6 @@
 /**
- * @param {string | undefined | null} keyFileJson
- * @returns {boolean}
+ *  @param {string | undefined | null} keyFileJson
+ *  @returns {boolean}
  */
 export default function hasKeyFileJson (keyFileJson = null) {
   try {

package/src/common/hasKeyFilePath.d.mts

@@ -1,5 +1,5 @@
 /**
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<boolean>}
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<boolean>}
  */
 export default function hasKeyFilePath (keyFilePath: string | undefined | null): Promise<boolean>

package/src/common/hasKeyFilePath.mjs

@@ -4,8 +4,8 @@ import {
 } from 'node:fs/promises'
 
 /**
- * @param {string | undefined | null} keyFilePath
- * @returns {Promise<boolean>}
+ *  @param {string | undefined | null} keyFilePath
+ *  @returns {Promise<boolean>}
  */
 export default async function hasKeyFilePath (keyFilePath = null) {
   try {

package/src/create/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * Create a JSON file in Google Drive
+ *  Create a JSON file in Google Drive
  */
 export default function createInDrive (
   driveId: string,

package/src/create/index.mjs

@@ -1,7 +1,7 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} AuthClient
- * @typedef {import('googleapis').drive_v3 } DriveV3
- * @typedef {DriveV3.Schema$File} File
+ *  @typedef {import('google-auth-library').OAuth2Client} AuthClient
+ *  @typedef {import('googleapis').drive_v3 } DriveV3
+ *  @typedef {DriveV3.Schema$File} File
  */
 
 import debug from 'debug'
@@ -36,13 +36,13 @@ const error = debug('@sequencemedia/drive/create:error')
 log('`@sequencemedia/drive` is awake')
 
 /**
- * Create a JSON file in Google Drive
+ *  Create a JSON file in Google Drive
  *
- * @param {string} driveId Drive identifier
- * @param {string} fileName JSON file identifier
- * @param {string} fileData JSON file contents
- * @param {AuthClient} authClient An authorised OAuth2 client
- * @returns {File}
+ *  @param {string} driveId Drive identifier
+ *  @param {string} fileName JSON file identifier
+ *  @param {string} fileData JSON file contents
+ *  @param {AuthClient} authClient An authorised OAuth2 client
+ *  @returns {File}
  */
 async function createJsonFile (driveId, fileName, fileData, authClient) {
   try {
@@ -78,14 +78,14 @@ async function createJsonFile (driveId, fileName, fileData, authClient) {
 }
 
 /**
- * Create a JSON file in Google Drive
+ *  Create a JSON file in Google Drive
  *
- * @param {string} driveId Drive identifier
- * @param {string} fileName JSON file name
- * @param {Buffer} fileData JSON file data
- * @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
- * @param {string[]} scopes Authorisation scopes
- * @returns {File}
+ *  @param {string} driveId Drive identifier
+ *  @param {string} fileName JSON file name
+ *  @param {Buffer} fileData JSON file data
+ *  @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
+ *  @param {string[]} scopes Authorisation scopes
+ *  @returns {File}
  */
 export default async function createInDrive (driveId, fileName, fileData, keyFile, scopes = SCOPES) {
   return (

package/src/delete/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * Delete a JSON file from Google Drive
+ *  Delete a JSON file from Google Drive
  */
 export default function deleteFromDrive (
   fileId: string,

package/src/delete/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} AuthClient
+ *  @typedef {import('google-auth-library').OAuth2Client} AuthClient
  */
 
 import debug from 'debug'
@@ -30,11 +30,11 @@ const error = debug('@sequencemedia/drive/delete:error')
 log('`@sequencemedia/drive` is awake')
 
 /**
- * Delete a JSON file from Google Drive
+ *  Delete a JSON file from Google Drive
  *
- * @param {string} fileId JSON file identifier
- * @param {AuthClient} authClient An authorised OAuth2 client
- * @returns {Promise<void>}
+ *  @param {string} fileId JSON file identifier
+ *  @param {AuthClient} authClient An authorised OAuth2 client
+ *  @returns {Promise<void>}
  */
 async function deleteJsonFile (fileId, authClient) {
   try {
@@ -56,11 +56,11 @@ async function deleteJsonFile (fileId, authClient) {
 }
 
 /**
- * Delete a JSON file from Google Drive
+ *  Delete a JSON file from Google Drive
  *
- * @param {string} fileId JSON file identifier
- * @param {Record<PropertyKey, string | undefined>} keyFile An authorised OAuth2 client
- * @returns {Promise<void>}
+ *  @param {string} fileId JSON file identifier
+ *  @param {Record<PropertyKey, string | undefined>} keyFile An authorised OAuth2 client
+ *  @returns {Promise<void>}
  */
 export default async function deleteFromDrive (fileId, keyFile, scopes = SCOPES) {
   return (

package/src/get/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * Get a JSON file from Google Drive
+ *  Get a JSON file from Google Drive
  */
 export default function getFromDrive (
   fileId: string,

package/src/get/index.mjs

@@ -1,7 +1,7 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} AuthClient
- * @typedef {import('googleapis').drive_v3 } DriveV3
- * @typedef {DriveV3.Schema$File} File
+ *  @typedef {import('google-auth-library').OAuth2Client} AuthClient
+ *  @typedef {import('googleapis').drive_v3 } DriveV3
+ *  @typedef {DriveV3.Schema$File} File
  */
 
 import debug from 'debug'
@@ -32,11 +32,11 @@ const error = debug('@sequencemedia/drive/get:error')
 log('`@sequencemedia/drive` is awake')
 
 /**
- * Get a JSON file from Google Drive
+ *  Get a JSON file from Google Drive
  *
- * @param {string} fileId JSON file identifier
- * @param {AuthClient} authClient An authorised OAuth2 client
- * @returns {File}
+ *  @param {string} fileId JSON file identifier
+ *  @param {AuthClient} authClient An authorised OAuth2 client
+ *  @returns {File}
  */
 async function getJsonFile (fileId, authClient) {
   try {
@@ -61,12 +61,12 @@ async function getJsonFile (fileId, authClient) {
 }
 
 /**
- * Get a JSON file from Google Drive
+ *  Get a JSON file from Google Drive
  *
- * @param {string} fileId JSON file identifier
- * @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
- * @param {string[]} scopes Authorisation scopes
- * @returns {Promise<File>}
+ *  @param {string} fileId JSON file identifier
+ *  @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
+ *  @param {string[]} scopes Authorisation scopes
+ *  @returns {Promise<File>}
  */
 export default async function getFromDrive (fileId, keyFile, scopes = SCOPES) {
   return (

package/src/get-list/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * Get a list of the JSON files from Google Drive
+ *  Get a list of the JSON files from Google Drive
  */
 export default function getListFromDrive (
   driveId: string,

package/src/get-list/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} AuthClient
+ *  @typedef {import('google-auth-library').OAuth2Client} AuthClient
  */
 
 import debug from 'debug'
@@ -30,11 +30,11 @@ const error = debug('@sequencemedia/drive/list:error')
 log('`@sequencemedia/drive` is awake')
 
 /**
- * Get a list of the JSON files from Google Drive
+ *  Get a list of the JSON files from Google Drive
  *
- * @param {string} driveId Drive identifier
- * @param {AuthClient} authClient An authorised OAuth2 client
- * @returns {Promise<{id: string, name: string}[]>}
+ *  @param {string} driveId Drive identifier
+ *  @param {AuthClient} authClient An authorised OAuth2 client
+ *  @returns {Promise<{id: string, name: string}[]>}
  */
 async function getJsonFileList (driveId, authClient) {
   try {
@@ -65,12 +65,12 @@ async function getJsonFileList (driveId, authClient) {
 }
 
 /**
- * Get a list of the JSON files from Google Drive
+ *  Get a list of the JSON files from Google Drive
  *
- * @param {string} driveId Drive identifier
- * @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
- * @param {string[]} scopes Authorisation scopes
- * @returns {Promise<Array<{id: string, name: string}>>}
+ *  @param {string} driveId Drive identifier
+ *  @param {Record<PropertyKey, string | undefined>} keyFile Authorisation
+ *  @param {string[]} scopes Authorisation scopes
+ *  @returns {Promise<Array<{id: string, name: string}>>}
  */
 export default async function getListFromDrive (driveId, keyFile, scopes = SCOPES) {
   return (

package/src/installed/index.mjs

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} OAuth2Client
- * @typedef {import('google-auth-library').JWTInput} UserRefreshClient
+ *  @typedef {import('google-auth-library').OAuth2Client} OAuth2Client
+ *  @typedef {import('google-auth-library').JWTInput} UserRefreshClient
  */
 
 import {
@@ -31,9 +31,9 @@ const SCOPES = [
 const USER_REFRESH_CLIENT_PATH = './user-refresh-client.json'
 
 /**
- * Deserialises `UserRefreshClient` from a file
+ *  Deserialises `UserRefreshClient` from a file
  *
- * @return {Promise<UserRefreshClient | null>}
+ *  @return {Promise<UserRefreshClient | null>}
  */
 async function getUserRefreshClient () {
   try {
@@ -47,10 +47,10 @@ async function getUserRefreshClient () {
 }
 
 /**
- * Serializes `UserRefreshClient` to a file
+ *  Serializes `UserRefreshClient` to a file
  *
- * @param {UserRefreshClient} userRefreshClient
- * @return {Promise<void>}
+ *  @param {UserRefreshClient} userRefreshClient
+ *  @return {Promise<void>}
  */
 async function setUserRefreshClient (userRefreshClient) {
   const fileData = JSON.stringify(userRefreshClient)
@@ -58,10 +58,10 @@ async function setUserRefreshClient (userRefreshClient) {
 }
 
 /**
- * Transforms `UserRefreshClient` to `OAuth2Client`
+ *  Transforms `UserRefreshClient` to `OAuth2Client`
  *
- * @param {UserRefreshClient} userRefreshClient
- * @returns {OAuth2Client}
+ *  @param {UserRefreshClient} userRefreshClient
+ *  @returns {OAuth2Client}
  */
 function toAuthClient (userRefreshClient) {
   return (
@@ -70,10 +70,10 @@ function toAuthClient (userRefreshClient) {
 }
 
 /**
- * Transforms `OAuth2Client` to `UserRefreshClient`
+ *  Transforms `OAuth2Client` to `UserRefreshClient`
  *
- * @param {OAuth2Client} authClient
- * @return {Promise<UserRefreshClient>}
+ *  @param {OAuth2Client} authClient
+ *  @return {Promise<UserRefreshClient>}
  */
 async function toUserRefreshClient (credentials, authClient) {
   const {
@@ -96,9 +96,9 @@ async function toUserRefreshClient (credentials, authClient) {
 }
 
 /**
- * Load or request or authorization to call APIs.
+ *  Load or request or authorization to call APIs.
  *
- * @return {OAuth2Client}
+ *  @return {OAuth2Client}
  */
 async function authorize () {
   const userRefreshClient = await getUserRefreshClient()
@@ -119,9 +119,9 @@ async function authorize () {
 }
 
 /**
- * Lists the names and IDs of up to 10 files.
+ *  Lists the names and IDs of up to 10 files.
  *
- * @param {OAuth2Client} authClient An authorized OAuth2 client.
+ *  @param {OAuth2Client} authClient An authorized OAuth2 client.
  */
 async function listFiles (authClient) {
   try {

package/src/upload/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('google-auth-library').OAuth2Client} OAuth2Client
+ *  @typedef {import('google-auth-library').OAuth2Client} OAuth2Client
  */
 
 import {
@@ -19,7 +19,7 @@ const SCOPES = [
 ]
 
 /**
- * Authorize with service account and get jwt client
+ *  Authorize with service account and get jwt client
  *
  */
 async function authorize () {
@@ -41,11 +41,11 @@ async function authorize () {
 }
 
 /**
- * Create a JSON file in Google Drive
+ *  Create a JSON file in Google Drive
  *
- * @param {string} id JSON file identifier
- * @param {string} body JSON file contents
- * @param {OAuth2Client} authClient An authorized OAuth2 client.
+ *  @param {string} id JSON file identifier
+ *  @param {string} body JSON file contents
+ *  @param {OAuth2Client} authClient An authorized OAuth2 client.
  */
 async function createJsonFile (id, body, authClient) {
   try {