rcs-js 2.0.0-rc.11 → 2.0.0-rc.13

package/dist/esm/wrapper/messages/Client.d.mts

@@ -0,0 +1,13 @@
+import { Messages } from "../../api/resources/messages/client/Client.mjs";
+import * as Pinnacle from "../../api/index.mjs";
+interface ExpressLikeRequest {
+    headers: Record<string, string | string[] | undefined>;
+    body?: any;
+    get?: (name: string) => string | undefined;
+    protocol?: string;
+    originalUrl?: string;
+}
+export declare class EnhancedMessages extends Messages {
+    process(req: Request | ExpressLikeRequest, secret?: string): Promise<Pinnacle.MessageEvent>;
+}
+export {};

package/dist/esm/wrapper/messages/Client.mjs

@@ -0,0 +1,45 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Messages } from "../../api/resources/messages/client/Client.mjs";
+import { UnauthorizedError } from "../../api/errors/index.mjs";
+export class EnhancedMessages extends Messages {
+    process(req, secret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const signingSecret = secret || process.env.PINNACLE_SIGNING_SECRET;
+            let headerSecret;
+            let body;
+            if (req instanceof Request) {
+                headerSecret =
+                    ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.get("PINNACLE-SIGNING-SECRET")) || ((_b = req.headers) === null || _b === void 0 ? void 0 : _b.get("pinnacle-signing-secret")) || undefined;
+                body = yield req.json();
+            }
+            else {
+                const headers = req.headers;
+                headerSecret = headers["pinnacle-signing-secret"];
+                body = req.body;
+            }
+            if (!signingSecret) {
+                throw new UnauthorizedError({
+                    error: "Make sure to set the PINNACLE-SIGNING-SECRET environment variable or pass the secret as an argument to the process method",
+                });
+            }
+            if (!headerSecret) {
+                throw new UnauthorizedError({
+                    error: "Failed to get the PINNACLE-SIGNING-SECRET header from request",
+                });
+            }
+            if (headerSecret !== signingSecret) {
+                throw new UnauthorizedError({ error: "Invalid webhook signature" });
+            }
+            return body;
+        });
+    }
+}

package/dist/esm/wrapper/tools/Client.d.mts

@@ -0,0 +1,6 @@
+import { Tools } from '../../api/resources/tools/client/Client.mjs';
+import { FileUploader } from './FileUploader.mjs';
+export declare class EnhancedTools extends Tools {
+    protected _fileUploader: FileUploader | undefined;
+    get file(): FileUploader;
+}

package/dist/esm/wrapper/tools/Client.mjs

@@ -0,0 +1,8 @@
+import { Tools } from '../../api/resources/tools/client/Client.mjs';
+import { FileUploader } from './FileUploader.mjs';
+export class EnhancedTools extends Tools {
+    get file() {
+        var _a;
+        return ((_a = this._fileUploader) !== null && _a !== void 0 ? _a : (this._fileUploader = new FileUploader(this._options)));
+    }
+}

package/dist/esm/wrapper/tools/FileUploader.d.mts

@@ -0,0 +1,15 @@
+import { File_ } from "../../api/resources/tools/resources/file/client/Client.mjs";
+import { UploadFileParams } from "../../api/resources/tools/resources/file/client/requests/index.mjs";
+export declare class FileUploader extends File_ {
+    /**
+     * Upload a file from a file path (Node.js) or File object (browser)
+     * @param fileInput - File path string (Node.js) or File object (browser)
+     * @param options - Upload options
+     * @returns The download URL of the uploaded file
+     */
+    uploadFromPath(fileInput: string | File, options?: {
+        name?: string;
+        options?: UploadFileParams.Options;
+    }): Promise<string>;
+    private getMimeType;
+}

package/dist/esm/wrapper/tools/FileUploader.mjs

@@ -0,0 +1,125 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as mime from "mime-types";
+import { File_ } from "../../api/resources/tools/resources/file/client/Client.mjs";
+import { BadRequestError, NotFoundError, InternalServerError } from "../../api/errors/index.mjs";
+export class FileUploader extends File_ {
+    /**
+     * Upload a file from a file path (Node.js) or File object (browser)
+     * @param fileInput - File path string (Node.js) or File object (browser)
+     * @param options - Upload options
+     * @returns The download URL of the uploaded file
+     */
+    uploadFromPath(fileInput, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let size;
+            let fileName;
+            let contentType;
+            let blob;
+            if (typeof window === "undefined") {
+                if (typeof fileInput !== "string") {
+                    throw new BadRequestError({ message: "In Node.js, fileInput must be a file path string" });
+                }
+                const fs = yield import("fs");
+                const path = yield import("path");
+                const filePath = fileInput;
+                let stats;
+                try {
+                    stats = yield fs.promises.stat(filePath);
+                }
+                catch (error) {
+                    if (error.code === "ENOENT") {
+                        throw new NotFoundError({ error: `File not found: ${filePath}` });
+                    }
+                    throw new InternalServerError({ error: `Failed to access file: ${error.message}` });
+                }
+                if (stats.isDirectory()) {
+                    throw new BadRequestError({ message: `Path is a directory, not a file: ${filePath}` });
+                }
+                size = stats.size;
+                fileName = (options === null || options === void 0 ? void 0 : options.name) || path.default.basename(filePath);
+                contentType = this.getMimeType(filePath);
+                const fileBuffer = yield fs.promises.readFile(filePath);
+                const arrayBuffer = new Uint8Array(fileBuffer).buffer;
+                blob = new Blob([arrayBuffer], { type: contentType });
+            }
+            else {
+                if (!(fileInput instanceof File)) {
+                    throw new BadRequestError({ message: "In browser, fileInput must be a File object" });
+                }
+                const file = fileInput;
+                size = file.size;
+                fileName = (options === null || options === void 0 ? void 0 : options.name) || file.name;
+                contentType = file.type || this.getMimeType(file.name);
+                blob = file;
+            }
+            const uploadParams = {
+                contentType,
+                size,
+                name: fileName,
+                options: options === null || options === void 0 ? void 0 : options.options,
+            };
+            const uploadResult = yield this.upload(uploadParams);
+            if (uploadResult.uploadUrl) {
+                yield fetch(uploadResult.uploadUrl, {
+                    method: "PUT",
+                    body: blob,
+                    headers: {
+                        "Content-Type": contentType,
+                    },
+                });
+            }
+            return uploadResult.downloadUrl;
+        });
+    }
+    getMimeType(filePath) {
+        const mimeType = mime.lookup(filePath);
+        if (!mimeType) {
+            return "application/octet-stream";
+        }
+        const supportedTypes = new Set([
+            "audio/mpeg",
+            "audio/mp4",
+            "audio/ogg",
+            "audio/aac",
+            "audio/webm",
+            "audio/wav",
+            "audio/3gpp",
+            "audio/amr",
+            "video/mp4",
+            "video/mpeg",
+            "video/quicktime",
+            "video/webm",
+            "video/3gpp",
+            "video/H264",
+            "video/x-m4v",
+            "image/jpeg",
+            "image/png",
+            "image/gif",
+            "image/bmp",
+            "image/tiff",
+            "image/webp",
+            "application/pdf",
+            "text/csv",
+            "application/rtf",
+            "text/vcard",
+            "text/calendar",
+        ]);
+        if (supportedTypes.has(mimeType)) {
+            return mimeType;
+        }
+        const baseType = mimeType.split("/")[0];
+        if (["audio", "video", "image"].includes(baseType)) {
+            console.warn(`MIME type ${mimeType} may not be fully supported. Proceeding anyway.`);
+            return mimeType;
+        }
+        return "application/octet-stream";
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.0-rc.11",
+    "version": "2.0.0-rc.13",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",
@@ -38,6 +38,9 @@
         "test:browser": "jest --selectProjects browser",
         "test:wire": "jest --selectProjects wire"
     },
+    "dependencies": {
+        "mime-types": "^3.0.1"
+    },
     "devDependencies": {
         "webpack": "^5.97.1",
         "ts-loader": "^9.5.1",
@@ -49,7 +52,8 @@
         "msw": "^2.8.4",
         "@types/node": "^18.19.70",
         "prettier": "^3.4.2",
-        "typescript": "~5.7.2"
+        "typescript": "~5.7.2",
+        "@types/mime-types": "^3.0.1"
     },
     "browser": {
         "fs": false,
@@ -62,4 +66,4 @@
         "node": ">=18.0.0"
     },
     "sideEffects": false
-}
+}

package/reference.md

@@ -2915,7 +2915,7 @@ await client.messages.rcs.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.Rcs`
+**request:** `Pinnacle.RichMessage`
 
 </dd>
 </dl>
@@ -3768,7 +3768,7 @@ See the response of [Create Shortened URL](./create-url) for more information.
 <dl>
 <dd>
 
-Update the destination or configuration of an existing shortened URL.
+Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
 
 </dd>
 </dl>
@@ -3907,6 +3907,80 @@ await client.tools.file.upload({
 </dl>
 </details>
 
+<details><summary><code>client.tools.file.<a href="/src/api/resources/tools/resources/file/client/Client.ts">refresh</a>({ ...params }) -> Pinnacle.RefreshedFile[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
+
+<Callout type="info">
+  This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
+</Callout>  
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tools.file.refresh({
+    uris: [
+        "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken",
+        "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2",
+        "icons/3/test.jpg",
+        "invalid/url",
+        "https://google.com",
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.tools.RefreshFileParams`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `File_.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Tools ContactCard
 
 <details><summary><code>client.tools.contactCard.<a href="/src/api/resources/tools/resources/contactCard/client/Client.ts">get</a>({ ...params }) -> Pinnacle.VCardData</code></summary>

package/dist/cjs/api/types/ClickAction.d.ts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ClickAction {
-    /** Title of the button or quick reply that was clicked on. */
-    button: string;
-    /** Payload received from the button interaction. */
-    data: ClickAction.Data;
-}
-export declare namespace ClickAction {
-    /**
-     * Payload received from the button interaction.
-     */
-    type Data = 
-    /**
-     * Data that is attached to the button. <br>
-     *
-     * This is only returned when `trigger` buttons are pressed. */
-    {
-        metadata: string;
-        payload: string;
-    }
-    /**
-     * Indicates that the button was clicked. <br>
-     *
-     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
-     | "clicked";
-}

package/dist/cjs/api/types/InboundButton.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
-export type InboundButton = 
-/**
- * Data associated with a button that is pressed. Excludes `requestUserLocation` and `sendLocation`. */
-Pinnacle.ClickAction
-/**
- * User provided location. Occurs when recipient responds to a `requestUserLocation` or `sendLocation` button. */
- | Pinnacle.LocationShareAction;

package/dist/esm/api/types/ClickAction.d.mts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ClickAction {
-    /** Title of the button or quick reply that was clicked on. */
-    button: string;
-    /** Payload received from the button interaction. */
-    data: ClickAction.Data;
-}
-export declare namespace ClickAction {
-    /**
-     * Payload received from the button interaction.
-     */
-    type Data = 
-    /**
-     * Data that is attached to the button. <br>
-     *
-     * This is only returned when `trigger` buttons are pressed. */
-    {
-        metadata: string;
-        payload: string;
-    }
-    /**
-     * Indicates that the button was clicked. <br>
-     *
-     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
-     | "clicked";
-}

package/dist/esm/api/types/InboundButton.d.mts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
-export type InboundButton = 
-/**
- * Data associated with a button that is pressed. Excludes `requestUserLocation` and `sendLocation`. */
-Pinnacle.ClickAction
-/**
- * User provided location. Occurs when recipient responds to a `requestUserLocation` or `sendLocation` button. */
- | Pinnacle.LocationShareAction;