@decaf-ts/integrations 0.12.0 → 0.14.0

package/lib/types/io/microsoft-sharepoint/MicrosoftSharePointService.d.mts

@@ -0,0 +1,226 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.mts";
+/**
+ * @description Configuration for the Microsoft SharePoint service
+ * @summary Extends {@link HttpApiServiceConfig} with the Microsoft Graph
+ * access token sent as a bearer token. When omitted, the
+ * `io.microsoftSharePoint` environment slice supplies the token (plus optional
+ * `baseUrl`/`timeout`).
+ * @category IO
+ * @memberOf module:integrations/io/microsoft-sharepoint/service
+ */
+export interface MicrosoftSharePointServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Microsoft Graph access token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+}
+/**
+ * @description Input for listing SharePoint list items
+ * @summary Carries the owning `siteId`, the `listId`, and optional `top` and
+ * `filter` query options.
+ * @category IO
+ * @memberOf module:integrations/io/microsoft-sharepoint/service
+ */
+export interface SharePointItemsInput {
+    /**
+     * @description SharePoint site ID
+     */
+    siteId: string;
+    /**
+     * @description List ID within the site
+     */
+    listId: string;
+    /**
+     * @description Maximum number of items to return (`$top`)
+     */
+    top?: number;
+    /**
+     * @description OData filter expression (`$filter`)
+     */
+    filter?: string;
+}
+/**
+ * @description Input for creating a SharePoint list item
+ * @summary Carries the owning `siteId`, the `listId`, and the item `fields`
+ * map to write.
+ * @category IO
+ * @memberOf module:integrations/io/microsoft-sharepoint/service
+ */
+export interface SharePointListItemInput {
+    /**
+     * @description SharePoint site ID
+     */
+    siteId: string;
+    /**
+     * @description List ID within the site
+     */
+    listId: string;
+    /**
+     * @description Column values for the new item
+     */
+    fields: Record<string, unknown>;
+}
+/**
+ * @description Input for listing a SharePoint drive folder's children
+ * @summary Carries the `siteId`, an optional folder `itemId` (default `root`),
+ * and an optional `top` cap.
+ * @category IO
+ * @memberOf module:integrations/io/microsoft-sharepoint/service
+ */
+export interface SharePointDriveItemsInput {
+    /**
+     * @description SharePoint site ID
+     */
+    siteId: string;
+    /**
+     * @description Drive item (folder) ID; defaults to the drive root
+     */
+    itemId?: string;
+    /**
+     * @description Maximum number of children to return (`$top`)
+     */
+    top?: number;
+}
+/**
+ * @description Microsoft SharePoint (Graph) integration service
+ * @summary An undecorated HTTP service for searching sites, reading a site's
+ * lists and list items, creating list items, and listing drive folder
+ * contents. Every operation requires a Graph access token; missing credentials
+ * or identifiers raise `InternalError`, and transport failures are mapped to
+ * decaf errors via {@link httpError}.
+ * @class MicrosoftSharePointService
+ * @extends HttpApiService
+ * @category IO
+ * @example
+ * ```ts
+ * import { MicrosoftSharePointService } from "@decaf-ts/integrations/io/microsoft-sharepoint";
+ *
+ * const sharepoint = new MicrosoftSharePointService();
+ * await sharepoint.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_MICROSOFT_SHAREPOINT_TOKEN,
+ * });
+ * const sites = await sharepoint.listSites("ops");
+ * ```
+ * @mermaid
+ * sequenceDiagram
+ *   autonumber
+ *   participant Caller
+ *   participant Service as MicrosoftSharePointService
+ *   participant Graph as Microsoft Graph
+ *   Caller->>Service: listItems(input)
+ *   activate Service
+ *   Service->>Service: requireAccessToken()
+ *   Service->>Graph: GET /sites/{siteId}/lists/{listId}/items
+ *   activate Graph
+ *   Graph-->>Service: list items payload
+ *   deactivate Graph
+ *   Service-->>Caller: list items payload
+ *   deactivate Service
+ * @memberOf module:integrations/io/microsoft-sharepoint/service
+ */
+export declare class MicrosoftSharePointService extends HttpApiService<MicrosoftSharePointServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "Microsoft SharePoint";
+    /**
+     * @description The Microsoft Graph base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://graph.microsoft.com/v1.0"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the Microsoft Graph bearer authorization headers
+     * @summary Returns `Authorization: Bearer <token>` when configured, and no
+     * headers otherwise.
+     * @param {MicrosoftSharePointServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: MicrosoftSharePointServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the SharePoint credentials and defaults from the environment
+     * @summary Reads the `io.microsoftSharePoint` slice and returns a partial
+     * config when an access token is configured, `undefined` otherwise. Values
+     * pass through `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<MicrosoftSharePointServiceConfig> | undefined} A partial config, or `undefined` when no SharePoint token is configured.
+     */
+    protected configFromEnvironment(): Partial<MicrosoftSharePointServiceConfig> | undefined;
+    /**
+     * @description Asserts that a Microsoft Graph access token is configured
+     * @summary Delegates to the shared `requireToken()` guard used by every
+     * operation.
+     * @returns {void}
+     * @throws {InternalError} When the resolved config has no `token`.
+     */
+    protected requireAccessToken(): void;
+    /**
+     * @description Builds the encoded path for a SharePoint site
+     * @summary Validates the site ID and URL-encodes it into `/sites/<id>`.
+     * @param {string} siteId - The SharePoint site ID.
+     * @returns {string} The site API path.
+     * @throws {InternalError} When `siteId` is empty.
+     */
+    private sitePath;
+    /**
+     * @description Searches SharePoint sites
+     * @summary `GET`s `/sites` with a `search` term (default `"*"`).
+     * @param {string} [search] - Site search term; defaults to `"*"`.
+     * @returns {Promise<unknown>} The site collection payload.
+     * @throws {InternalError} When no token is configured.
+     * @throws {BadRequestError} When Graph rejects the request.
+     */
+    listSites(search?: string): Promise<unknown>;
+    /**
+     * @description Fetches a SharePoint site
+     * @summary `GET`s `/sites/<id>` and returns the site payload.
+     * @param {string} siteId - The site ID to fetch.
+     * @returns {Promise<unknown>} The site payload.
+     * @throws {InternalError} When no token is configured or the site ID is empty.
+     * @throws {NotFoundError} When the site does not exist (HTTP 404).
+     * @throws {BadRequestError} When Graph rejects the request.
+     */
+    getSite(siteId: string): Promise<unknown>;
+    /**
+     * @description Lists the lists in a SharePoint site
+     * @summary `GET`s `/sites/<id>/lists`.
+     * @param {string} siteId - The site whose lists are listed.
+     * @returns {Promise<unknown>} The list collection payload.
+     * @throws {InternalError} When no token is configured or the site ID is empty.
+     * @throws {NotFoundError} When the site does not exist (HTTP 404).
+     * @throws {BadRequestError} When Graph rejects the request.
+     */
+    listLists(siteId: string): Promise<unknown>;
+    /**
+     * @description Lists items in a SharePoint list
+     * @summary `GET`s the list's `/items` endpoint expanding `fields` and
+     * applying the optional `$top` and `$filter` options.
+     * @param {SharePointItemsInput} input - The site, list, and query options.
+     * @returns {Promise<unknown>} The list item collection payload.
+     * @throws {InternalError} When no token is configured, or the site or list ID is empty.
+     * @throws {NotFoundError} When the site or list does not exist (HTTP 404).
+     * @throws {BadRequestError} When Graph rejects the query.
+     */
+    listItems(input: SharePointItemsInput): Promise<unknown>;
+    /**
+     * @description Creates a SharePoint list item
+     * @summary `POST`s the `fields` map to the list's `/items` endpoint.
+     * @param {SharePointListItemInput} input - The site, list, and item fields.
+     * @returns {Promise<unknown>} The created item payload.
+     * @throws {InternalError} When no token is configured, or the site, list, or fields are missing.
+     * @throws {NotFoundError} When the site or list does not exist (HTTP 404).
+     * @throws {BadRequestError} When Graph rejects the item.
+     */
+    createListItem(input: SharePointListItemInput): Promise<unknown>;
+    /**
+     * @description Lists the children of a SharePoint drive folder
+     * @summary `GET`s `/sites/<id>/drive/items/<item or root>/children` with an
+     * optional `$top` cap.
+     * @param {SharePointDriveItemsInput} input - The site, folder, and result cap.
+     * @returns {Promise<unknown>} The drive item collection payload.
+     * @throws {InternalError} When no token is configured or the site ID is empty.
+     * @throws {NotFoundError} When the site or folder does not exist (HTTP 404).
+     * @throws {BadRequestError} When Graph rejects the request.
+     */
+    listDriveItems(input: SharePointDriveItemsInput): Promise<unknown>;
+}

package/lib/types/io/microsoft-sharepoint/index.d.cts

@@ -0,0 +1 @@
+export * from "./MicrosoftSharePointService.d.cts";

package/lib/types/io/microsoft-sharepoint/index.d.mts

@@ -0,0 +1 @@
+export * from "./MicrosoftSharePointService.d.mts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/integrations",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.mts",
@@ -258,6 +258,17 @@
       },
       "default": "./lib/esm/calendar/index.js"
     },
+    "./calendar/google-calendar": {
+      "import": {
+        "types": "./lib/types/calendar/google-calendar/index.d.mts",
+        "default": "./lib/esm/calendar/google-calendar/index.js"
+      },
+      "require": {
+        "types": "./lib/types/calendar/google-calendar/index.d.cts",
+        "default": "./lib/cjs/calendar/google-calendar/index.cjs"
+      },
+      "default": "./lib/esm/calendar/google-calendar/index.js"
+    },
     "./sftp": {
       "import": {
         "types": "./lib/types/sftp/index.d.mts",
@@ -357,6 +368,39 @@
       },
       "default": "./lib/esm/comms/telegram/index.js"
     },
+    "./comms/discord": {
+      "import": {
+        "types": "./lib/types/comms/discord/index.d.mts",
+        "default": "./lib/esm/comms/discord/index.js"
+      },
+      "require": {
+        "types": "./lib/types/comms/discord/index.d.cts",
+        "default": "./lib/cjs/comms/discord/index.cjs"
+      },
+      "default": "./lib/esm/comms/discord/index.js"
+    },
+    "./comms/whatsapp": {
+      "import": {
+        "types": "./lib/types/comms/whatsapp/index.d.mts",
+        "default": "./lib/esm/comms/whatsapp/index.js"
+      },
+      "require": {
+        "types": "./lib/types/comms/whatsapp/index.d.cts",
+        "default": "./lib/cjs/comms/whatsapp/index.cjs"
+      },
+      "default": "./lib/esm/comms/whatsapp/index.js"
+    },
+    "./comms/outlook": {
+      "import": {
+        "types": "./lib/types/comms/outlook/index.d.mts",
+        "default": "./lib/esm/comms/outlook/index.js"
+      },
+      "require": {
+        "types": "./lib/types/comms/outlook/index.d.cts",
+        "default": "./lib/cjs/comms/outlook/index.cjs"
+      },
+      "default": "./lib/esm/comms/outlook/index.js"
+    },
     "./devops": {
       "import": {
         "types": "./lib/types/devops/index.d.mts",
@@ -445,6 +489,61 @@
       },
       "default": "./lib/esm/io/spreadsheet/index.js"
     },
+    "./io/microsoft-excel": {
+      "import": {
+        "types": "./lib/types/io/microsoft-excel/index.d.mts",
+        "default": "./lib/esm/io/microsoft-excel/index.js"
+      },
+      "require": {
+        "types": "./lib/types/io/microsoft-excel/index.d.cts",
+        "default": "./lib/cjs/io/microsoft-excel/index.cjs"
+      },
+      "default": "./lib/esm/io/microsoft-excel/index.js"
+    },
+    "./io/confluence": {
+      "import": {
+        "types": "./lib/types/io/confluence/index.d.mts",
+        "default": "./lib/esm/io/confluence/index.js"
+      },
+      "require": {
+        "types": "./lib/types/io/confluence/index.d.cts",
+        "default": "./lib/cjs/io/confluence/index.cjs"
+      },
+      "default": "./lib/esm/io/confluence/index.js"
+    },
+    "./io/jira": {
+      "import": {
+        "types": "./lib/types/io/jira/index.d.mts",
+        "default": "./lib/esm/io/jira/index.js"
+      },
+      "require": {
+        "types": "./lib/types/io/jira/index.d.cts",
+        "default": "./lib/cjs/io/jira/index.cjs"
+      },
+      "default": "./lib/esm/io/jira/index.js"
+    },
+    "./io/google-docs": {
+      "import": {
+        "types": "./lib/types/io/google-docs/index.d.mts",
+        "default": "./lib/esm/io/google-docs/index.js"
+      },
+      "require": {
+        "types": "./lib/types/io/google-docs/index.d.cts",
+        "default": "./lib/cjs/io/google-docs/index.cjs"
+      },
+      "default": "./lib/esm/io/google-docs/index.js"
+    },
+    "./io/microsoft-sharepoint": {
+      "import": {
+        "types": "./lib/types/io/microsoft-sharepoint/index.d.mts",
+        "default": "./lib/esm/io/microsoft-sharepoint/index.js"
+      },
+      "require": {
+        "types": "./lib/types/io/microsoft-sharepoint/index.d.cts",
+        "default": "./lib/cjs/io/microsoft-sharepoint/index.cjs"
+      },
+      "default": "./lib/esm/io/microsoft-sharepoint/index.js"
+    },
     "./plugins": {
       "import": {
         "types": "./lib/types/plugins/index.d.mts",
@@ -569,7 +668,7 @@
     "@decaf-ts/for-http": "latest",
     "@decaf-ts/for-nest": "latest",
     "jose": ">=5.0.0",
-    "nodemailer": ">=7.0.0",
+    "nodemailer": "^10.1.7",
     "pg": ">=8.0.0"
   },
   "peerDependenciesMeta": {
@@ -601,10 +700,7 @@
     "@azure/storage-blob": "^12.33.0",
     "@google-cloud/secret-manager": "^5.6.0",
     "@google-cloud/storage": "^7.21.0",
-    "hashicorp-vault": "^0.1.0",
     "imapflow": "^1.7.1",
-    "keycloak-admin": "^24.0.5",
-    "onelogin-node": "^0.1.0",
     "ssh2": "^1.16.0"
   }
 }