@openfn/language-msgraph 0.1.1 → 0.3.0

package/ast.json

@@ -125,6 +125,207 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "getDrive",
+      "params": [
+        "specifier",
+        "name",
+        "callback"
+      ],
+      "docs": {
+        "description": "Get a Drive or SharePoint document library. The drive metadata will be written\nto state.drives, where it can be used by other adaptor functions.\nPass { id } to get a drive by id or { id, owner } to get default drive for\nsome parent resource, like a group",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "getDrive({ id: \"YXzpkoLwR06bxC8tNdg71m\" })",
+            "caption": "Get a drive by ID"
+          },
+          {
+            "title": "example",
+            "description": "getDrive({ id: \"openfn.sharepoint.com\", owner: \"sites\" })",
+            "caption": "Get the default drive for a site"
+          },
+          {
+            "title": "param",
+            "description": "{Object} - A definition of the drive to retrieve\n   - id {string} - The ID of the resource or owner.\n   - owner {string} - The type of drive owner (e.g. sites, groups).",
+            "type": null,
+            "name": "specifier"
+          },
+          {
+            "title": "param",
+            "description": "The local name of the drive used to write to state.drives, ie, state.drives[name]",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "name"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) Callback function",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "function"
+              }
+            },
+            "name": "callback",
+            "default": "s=>s"
+          },
+          {
+            "title": "return",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
+    {
+      "name": "getFolder",
+      "params": [
+        "pathOrId",
+        "options",
+        "callback"
+      ],
+      "docs": {
+        "description": "Get the contents or metadata of a folder.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "getFolder('01LUM6XOCKDTZKQC7AVZF2VMHE2I3O6OY3')",
+            "caption": "Get a folder by ID"
+          },
+          {
+            "title": "example",
+            "description": "getFolder(\"01LUM6XOCKDTZKQC7AVZF2VMHE2I3O6OY3\",{ driveName: \"mydrive\"})",
+            "caption": "Get a folder for a named drive by id"
+          },
+          {
+            "title": "param",
+            "description": "A path to a folder or folder id",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "pathOrId"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) Query parameters",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "options"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) Callback function",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "function"
+              }
+            },
+            "name": "callback",
+            "default": "s=>s"
+          },
+          {
+            "title": "return",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
+    {
+      "name": "getFile",
+      "params": [
+        "pathOrId",
+        "options",
+        "callback"
+      ],
+      "docs": {
+        "description": "Get file metadata or file content.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "getFile('01LUM6XOGRONYNTZ26DBBJPTN5IFTQPBIW')",
+            "caption": "Get a file by ID"
+          },
+          {
+            "title": "example",
+            "description": "getFile(\"01LUM6XOGRONYNTZ26DBBJPTN5IFTQPBIW\",{ driveName: \"mydrive\"})",
+            "caption": "Get a file for a named drive by id"
+          },
+          {
+            "title": "param",
+            "description": "A path to a file or file id",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "pathOrId"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) Query parameters",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "options"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) Callback function",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "function"
+              }
+            },
+            "name": "callback",
+            "default": "s=>s"
+          },
+          {
+            "title": "return",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
     }
   ],
   "exports": [],
@@ -545,6 +746,80 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "parseCsv",
+      "params": [
+        "csvData",
+        "parsingOptions",
+        "callback"
+      ],
+      "docs": {
+        "description": "Takes a CSV file string or stream and parsing options as input, and returns a promise that\nresolves to the parsed CSV data as an array of objects.\nOptions for `parsingOptions` include:\n- `delimiter` {string/Buffer/[string/Buffer]} - Defines the character(s) used to delineate the fields inside a record. Default: `','`\n- `quote` {string/Buffer/[string/Buffer]} - Defines the characters used to surround a field. Default: `'\"'`\n- `escape` {Buffer/string/null/boolean} - Set the escape character as one character/byte only. Default: `\"`\n- `columns` {boolean / array / function} - Generates record in the form of object literals. Default: `true`\n- `bom` {boolean} - Strips the {@link https://en.wikipedia.org/wiki/Byte_order_mark byte order mark (BOM)} from the input string or buffer. Default: `true`\n- `trim` {boolean} - Ignore whitespace characters immediately around the `delimiter`. Default: `true`\n- `ltrim` {boolean} - Ignore whitespace characters from the left side of a CSV field. Default: `true`\n- `rtrim` {boolean} - Ignore whitespace characters from the right side of a CSV field. Default: `true`\n- `chunkSize` {number} - The size of each chunk of CSV data. Default: `Infinity`\n- `skip_empty_lines` {boolean} - Ignore empty lines in the CSV file. Default: `true`",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "A CSV string or a readable stream",
+            "type": {
+              "type": "UnionType",
+              "elements": [
+                {
+                  "type": "NameExpression",
+                  "name": "String"
+                },
+                {
+                  "type": "NameExpression",
+                  "name": "Stream"
+                }
+              ]
+            },
+            "name": "csvData"
+          },
+          {
+            "title": "param",
+            "description": "Optional. Parsing options for converting CSV to JSON.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "Object"
+              }
+            },
+            "name": "parsingOptions"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) callback function. If used it will be called state and an array of rows.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "function"
+              }
+            },
+            "name": "callback"
+          },
+          {
+            "title": "returns",
+            "description": "The function returns a Promise that resolves to the result of parsing a CSV `stringOrStream`.",
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
     }
   ]
 }

package/dist/index.cjs

@@ -30,8 +30,12 @@ __export(src_exports, {
   fields: () => import_language_common3.fields,
   fn: () => import_language_common3.fn,
   get: () => get,
+  getDrive: () => getDrive,
+  getFile: () => getFile,
+  getFolder: () => getFolder,
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   merge: () => import_language_common3.merge,
+  parseCsv: () => import_language_common3.parseCsv,
   request: () => request,
   sourceValue: () => import_language_common3.sourceValue
 });
@@ -50,20 +54,35 @@ __export(Adaptor_exports, {
   fields: () => import_language_common3.fields,
   fn: () => import_language_common3.fn,
   get: () => get,
+  getDrive: () => getDrive,
+  getFile: () => getFile,
+  getFolder: () => getFolder,
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   merge: () => import_language_common3.merge,
+  parseCsv: () => import_language_common3.parseCsv,
   request: () => request,
   sourceValue: () => import_language_common3.sourceValue
 });
 var import_language_common2 = require("@openfn/language-common");
+var import_util = require("@openfn/language-common/util");
 
 // src/Utils.js
+var import_undici = require("undici");
 var import_language_common = require("@openfn/language-common");
-function setUrl(urlParams) {
-  const { apiVersion, resolvePath } = urlParams;
-  if (isValidHttpUrl(resolvePath))
-    return resolvePath;
-  const pathSuffix = apiVersion ? `${apiVersion}/${resolvePath}` : `v1.0/${resolvePath}`;
+function assertDrive(state, driveName) {
+  if (!state.drives[driveName]) {
+    const errorString = [
+      `Drive is not defined.`,
+      `At the top of your job you should define all the drives you want to use.`,
+      `eg: getDrive({ id: "openfn.sharepoint.com", owner: "sites"})`
+    ].join("\n	\u221F ");
+    throw new Error(errorString);
+  }
+}
+function getUrl(resource, apiVersion) {
+  if (isValidHttpUrl(resource))
+    return resource;
+  const pathSuffix = apiVersion ? `${apiVersion}/${resource}` : `v1.0/${resource}`;
   return `https://graph.microsoft.com/${pathSuffix}`;
 }
 function isValidHttpUrl(string) {
@@ -75,7 +94,7 @@ function isValidHttpUrl(string) {
   }
   return url.protocol === "http:" || url.protocol === "https:";
 }
-function setAuth(token) {
+function getAuth(token) {
   return token ? { headers: { Authorization: `Bearer ${token}` } } : null;
 }
 function handleResponse(response, state, callback) {
@@ -114,7 +133,7 @@ var request = async (urlString, params = {}, method = "GET") => {
   } else {
     options.body = JSON.stringify(params);
   }
-  const response = await fetch(url, options);
+  const response = await (0, import_undici.fetch)(url, options);
   const contentType = response.headers.get("Content-Type");
   const data = (contentType == null ? void 0 : contentType.includes("application/json")) ? await response.json() : await response.text();
   handleResponseError(response, data, method);
@@ -126,25 +145,33 @@ var import_language_common3 = require("@openfn/language-common");
 function execute(...operations) {
   const initialState = {
     references: [],
-    data: null
+    data: null,
+    drives: {}
+  };
+  const cleanup = (finalState) => {
+    const { drives, ...rest } = finalState;
+    return rest;
   };
   return (state) => {
     return (0, import_language_common2.execute)(...operations)({
       ...initialState,
       ...state
-    });
+    }).then(cleanup).catch(cleanup);
   };
 }
 function create(resource, data, callback) {
   return (state) => {
-    const resolveResource = (0, import_language_common2.expandReferences)(resource)(state);
-    const resolveData = (0, import_language_common2.expandReferences)(data)(state);
+    const [resolvedResource, resolvedData] = (0, import_util.expandReferences)(
+      state,
+      resource,
+      data
+    );
     const { accessToken, apiVersion } = state.configuration;
-    const url = setUrl({ apiVersion, resolveResource });
-    const auth = setAuth(accessToken);
+    const url = getUrl({ apiVersion, resolvedResource });
+    const auth = getAuth(accessToken);
     const options = {
       auth,
-      ...resolveData
+      ...resolvedData
     };
     return request(url, options, "POST").then(
       (response) => handleResponse(response, state, callback)
@@ -153,12 +180,103 @@ function create(resource, data, callback) {
 }
 function get(path, query, callback = false) {
   return (state) => {
-    const resolvePath = (0, import_language_common2.expandReferences)(path)(state);
-    const resolveQuery = (0, import_language_common2.expandReferences)(query)(state);
     const { accessToken, apiVersion } = state.configuration;
-    const url = setUrl({ apiVersion, resolvePath });
-    const auth = setAuth(accessToken);
-    return request(url, { ...resolveQuery, ...auth }).then(
+    const [resolvedPath, resolvedQuery] = (0, import_util.expandReferences)(state, path, query);
+    const url = getUrl(resolvedPath, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...resolvedQuery, ...auth }).then(
+      (response) => handleResponse(response, state, callback)
+    );
+  };
+}
+function getDrive(specifier, name = "default", callback = (s) => s) {
+  return (state) => {
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedSpecifier, resolvedName] = (0, import_util.expandReferences)(
+      state,
+      specifier,
+      name
+    );
+    const { id, owner = "drive" } = resolvedSpecifier;
+    let resource;
+    if (owner === "drive") {
+      resource = `drives/${id}`;
+    } else {
+      resource = `${owner}/${id}/drive`;
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then((response) => {
+      state.drives[resolvedName] = response;
+      return callback(state);
+    });
+  };
+}
+function getFolder(pathOrId, options, callback = (s) => s) {
+  return async (state) => {
+    const defaultOptions = {
+      driveName: "default",
+      metadata: false
+    };
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedPathOrId, resolvedOptions] = (0, import_util.expandReferences)(
+      state,
+      pathOrId,
+      options
+    );
+    const { driveName, metadata } = { ...defaultOptions, ...resolvedOptions };
+    assertDrive(state, driveName);
+    const { id: driveId } = state.drives[driveName];
+    let resource;
+    if (resolvedPathOrId.startsWith("/")) {
+      resource = `drives/${driveId}/root:/${encodeURIComponent(
+        resolvedPathOrId
+      )}`;
+    } else {
+      resource = `drives/${driveId}/items/${resolvedPathOrId}`;
+    }
+    if (!metadata) {
+      resource += resolvedPathOrId.startsWith("/") ? ":/children" : "/children";
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then(
+      (response) => handleResponse(response, state, callback)
+    );
+  };
+}
+function getFile(pathOrId, options, callback = (s) => s) {
+  return async (state) => {
+    const defaultOptions = {
+      driveName: "default",
+      metadata: false
+    };
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedPathOrId, resolvedOptions] = (0, import_util.expandReferences)(
+      state,
+      pathOrId,
+      options
+    );
+    const { driveName, metadata } = {
+      ...defaultOptions,
+      ...resolvedOptions
+    };
+    assertDrive(state, driveName);
+    const { id: driveId } = state.drives[driveName];
+    let resource;
+    if (resolvedPathOrId.startsWith("/")) {
+      resource = `drives/${driveId}/root:/${encodeURIComponent(
+        resolvedPathOrId
+      )}`;
+    } else {
+      resource = `drives/${driveId}/items/${resolvedPathOrId}`;
+    }
+    if (!metadata) {
+      resource += resolvedPathOrId.startsWith("/") ? ":/content" : "/content";
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then(
       (response) => handleResponse(response, state, callback)
     );
   };
@@ -178,8 +296,12 @@ var src_default = Adaptor_exports;
   fields,
   fn,
   get,
+  getDrive,
+  getFile,
+  getFolder,
   lastReferenceValue,
   merge,
+  parseCsv,
   request,
   sourceValue
 });

package/dist/index.js

@@ -17,23 +17,35 @@ __export(Adaptor_exports, {
   fields: () => fields,
   fn: () => fn,
   get: () => get,
+  getDrive: () => getDrive,
+  getFile: () => getFile,
+  getFolder: () => getFolder,
   lastReferenceValue: () => lastReferenceValue,
   merge: () => merge,
+  parseCsv: () => parseCsv,
   request: () => request,
   sourceValue: () => sourceValue
 });
-import {
-  execute as commonExecute,
-  expandReferences
-} from "@openfn/language-common";
+import { execute as commonExecute } from "@openfn/language-common";
+import { expandReferences } from "@openfn/language-common/util";
 
 // src/Utils.js
+import { fetch } from "undici";
 import { composeNextState } from "@openfn/language-common";
-function setUrl(urlParams) {
-  const { apiVersion, resolvePath } = urlParams;
-  if (isValidHttpUrl(resolvePath))
-    return resolvePath;
-  const pathSuffix = apiVersion ? `${apiVersion}/${resolvePath}` : `v1.0/${resolvePath}`;
+function assertDrive(state, driveName) {
+  if (!state.drives[driveName]) {
+    const errorString = [
+      `Drive is not defined.`,
+      `At the top of your job you should define all the drives you want to use.`,
+      `eg: getDrive({ id: "openfn.sharepoint.com", owner: "sites"})`
+    ].join("\n	\u221F ");
+    throw new Error(errorString);
+  }
+}
+function getUrl(resource, apiVersion) {
+  if (isValidHttpUrl(resource))
+    return resource;
+  const pathSuffix = apiVersion ? `${apiVersion}/${resource}` : `v1.0/${resource}`;
   return `https://graph.microsoft.com/${pathSuffix}`;
 }
 function isValidHttpUrl(string) {
@@ -45,7 +57,7 @@ function isValidHttpUrl(string) {
   }
   return url.protocol === "http:" || url.protocol === "https:";
 }
-function setAuth(token) {
+function getAuth(token) {
   return token ? { headers: { Authorization: `Bearer ${token}` } } : null;
 }
 function handleResponse(response, state, callback) {
@@ -102,30 +114,39 @@ import {
   fn,
   lastReferenceValue,
   merge,
-  sourceValue
+  sourceValue,
+  parseCsv
 } from "@openfn/language-common";
 function execute(...operations) {
   const initialState = {
     references: [],
-    data: null
+    data: null,
+    drives: {}
+  };
+  const cleanup = (finalState) => {
+    const { drives, ...rest } = finalState;
+    return rest;
   };
   return (state) => {
     return commonExecute(...operations)({
       ...initialState,
       ...state
-    });
+    }).then(cleanup).catch(cleanup);
   };
 }
 function create(resource, data, callback) {
   return (state) => {
-    const resolveResource = expandReferences(resource)(state);
-    const resolveData = expandReferences(data)(state);
+    const [resolvedResource, resolvedData] = expandReferences(
+      state,
+      resource,
+      data
+    );
     const { accessToken, apiVersion } = state.configuration;
-    const url = setUrl({ apiVersion, resolveResource });
-    const auth = setAuth(accessToken);
+    const url = getUrl({ apiVersion, resolvedResource });
+    const auth = getAuth(accessToken);
     const options = {
       auth,
-      ...resolveData
+      ...resolvedData
     };
     return request(url, options, "POST").then(
       (response) => handleResponse(response, state, callback)
@@ -134,12 +155,103 @@ function create(resource, data, callback) {
 }
 function get(path, query, callback = false) {
   return (state) => {
-    const resolvePath = expandReferences(path)(state);
-    const resolveQuery = expandReferences(query)(state);
     const { accessToken, apiVersion } = state.configuration;
-    const url = setUrl({ apiVersion, resolvePath });
-    const auth = setAuth(accessToken);
-    return request(url, { ...resolveQuery, ...auth }).then(
+    const [resolvedPath, resolvedQuery] = expandReferences(state, path, query);
+    const url = getUrl(resolvedPath, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...resolvedQuery, ...auth }).then(
+      (response) => handleResponse(response, state, callback)
+    );
+  };
+}
+function getDrive(specifier, name = "default", callback = (s) => s) {
+  return (state) => {
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedSpecifier, resolvedName] = expandReferences(
+      state,
+      specifier,
+      name
+    );
+    const { id, owner = "drive" } = resolvedSpecifier;
+    let resource;
+    if (owner === "drive") {
+      resource = `drives/${id}`;
+    } else {
+      resource = `${owner}/${id}/drive`;
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then((response) => {
+      state.drives[resolvedName] = response;
+      return callback(state);
+    });
+  };
+}
+function getFolder(pathOrId, options, callback = (s) => s) {
+  return async (state) => {
+    const defaultOptions = {
+      driveName: "default",
+      metadata: false
+    };
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedPathOrId, resolvedOptions] = expandReferences(
+      state,
+      pathOrId,
+      options
+    );
+    const { driveName, metadata } = { ...defaultOptions, ...resolvedOptions };
+    assertDrive(state, driveName);
+    const { id: driveId } = state.drives[driveName];
+    let resource;
+    if (resolvedPathOrId.startsWith("/")) {
+      resource = `drives/${driveId}/root:/${encodeURIComponent(
+        resolvedPathOrId
+      )}`;
+    } else {
+      resource = `drives/${driveId}/items/${resolvedPathOrId}`;
+    }
+    if (!metadata) {
+      resource += resolvedPathOrId.startsWith("/") ? ":/children" : "/children";
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then(
+      (response) => handleResponse(response, state, callback)
+    );
+  };
+}
+function getFile(pathOrId, options, callback = (s) => s) {
+  return async (state) => {
+    const defaultOptions = {
+      driveName: "default",
+      metadata: false
+    };
+    const { accessToken, apiVersion } = state.configuration;
+    const [resolvedPathOrId, resolvedOptions] = expandReferences(
+      state,
+      pathOrId,
+      options
+    );
+    const { driveName, metadata } = {
+      ...defaultOptions,
+      ...resolvedOptions
+    };
+    assertDrive(state, driveName);
+    const { id: driveId } = state.drives[driveName];
+    let resource;
+    if (resolvedPathOrId.startsWith("/")) {
+      resource = `drives/${driveId}/root:/${encodeURIComponent(
+        resolvedPathOrId
+      )}`;
+    } else {
+      resource = `drives/${driveId}/items/${resolvedPathOrId}`;
+    }
+    if (!metadata) {
+      resource += resolvedPathOrId.startsWith("/") ? ":/content" : "/content";
+    }
+    const url = getUrl(resource, apiVersion);
+    const auth = getAuth(accessToken);
+    return request(url, { ...auth }).then(
       (response) => handleResponse(response, state, callback)
     );
   };
@@ -159,8 +271,12 @@ export {
   fields,
   fn,
   get,
+  getDrive,
+  getFile,
+  getFolder,
   lastReferenceValue,
   merge,
+  parseCsv,
   request,
   sourceValue
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-msgraph",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Microsoft Graph Language Pack for OpenFn",
   "type": "module",
   "exports": {
@@ -19,7 +19,8 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "^1.10.0"
+    "@openfn/language-common": "^1.10.1",
+    "undici": "^5.22.1"
   },
   "devDependencies": {
     "@openfn/buildtools": "^1.0.2",
@@ -29,8 +30,7 @@
     "deep-eql": "4.1.1",
     "esno": "^0.16.3",
     "mocha": "9.2.2",
-    "rimraf": "3.0.2",
-    "undici": "^5.22.1"
+    "rimraf": "3.0.2"
   },
   "repository": {
     "type": "git",

package/types/Adaptor.d.ts

@@ -35,5 +35,49 @@ export function create(resource: string, data: object, callback: Function): Oper
  * @returns {Operation}
  */
 export function get(path: string, query: object, callback?: Function): Operation;
+/**
+ * Get a Drive or SharePoint document library. The drive metadata will be written
+ * to state.drives, where it can be used by other adaptor functions.
+ * Pass { id } to get a drive by id or { id, owner } to get default drive for
+ * some parent resource, like a group
+ * @public
+ * @example <caption>Get a drive by ID</caption>
+ * getDrive({ id: "YXzpkoLwR06bxC8tNdg71m" })
+ * @example <caption>Get the default drive for a site</caption>
+ * getDrive({ id: "openfn.sharepoint.com", owner: "sites" })
+ * @param specifier {Object} - A definition of the drive to retrieve
+ *    - id {string} - The ID of the resource or owner.
+ *    - owner {string} - The type of drive owner (e.g. sites, groups).
+ * @param {string} name - The local name of the drive used to write to state.drives, ie, state.drives[name]
+ * @param {function} [callback = s => s] (Optional) Callback function
+ * @return {Operation}
+ */
+export function getDrive(specifier: any, name?: string, callback?: Function): Operation;
+/**
+ * Get the contents or metadata of a folder.
+ * @public
+ * @example <caption>Get a folder by ID</caption>
+ * getFolder('01LUM6XOCKDTZKQC7AVZF2VMHE2I3O6OY3')
+ * @example <caption>Get a folder for a named drive by id</caption>
+ * getFolder("01LUM6XOCKDTZKQC7AVZF2VMHE2I3O6OY3",{ driveName: "mydrive"})
+ * @param {string} pathOrId - A path to a folder or folder id
+ * @param {object} options - (Optional) Query parameters
+ * @param {function} [callback = s => s] (Optional) Callback function
+ * @return {Operation}
+ */
+export function getFolder(pathOrId: string, options: object, callback?: Function): Operation;
+/**
+ * Get file metadata or file content.
+ * @public
+ * @example <caption>Get a file by ID</caption>
+ * getFile('01LUM6XOGRONYNTZ26DBBJPTN5IFTQPBIW')
+ * @example <caption>Get a file for a named drive by id</caption>
+ * getFile("01LUM6XOGRONYNTZ26DBBJPTN5IFTQPBIW",{ driveName: "mydrive"})
+ * @param {string} pathOrId - A path to a file or file id
+ * @param {object} options - (Optional) Query parameters
+ * @param {function} [callback = s => s] (Optional) Callback function
+ * @return {Operation}
+ */
+export function getFile(pathOrId: string, options: object, callback?: Function): Operation;
 export { request } from "./Utils";
-export { dataPath, dataValue, dateFns, each, field, fields, fn, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+export { dataPath, dataValue, dateFns, each, field, fields, fn, lastReferenceValue, merge, sourceValue, parseCsv } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -1,9 +1,10 @@
-export function setUrl(urlParams: any): any;
-export function setAuth(token: any): {
+export function assertDrive(state: any, driveName: any): void;
+export function getUrl(resource: any, apiVersion: any): any;
+export function getAuth(token: any): {
     headers: {
         Authorization: string;
     };
 };
 export function handleResponse(response: any, state: any, callback: any): any;
 export function handleResponseError(response: any, data: any, method: any): void;
-export function request(urlString: any, params?: object, method?: string): Promise<any>;
+export function request(urlString: any, params?: object, method?: string): Promise<unknown>;