🤖 Merge PR DefinitelyTyped#72059 Added types for pageclip by @max-programming

Author: max-programming

types/pageclip/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/pageclip/index.d.ts

@@ -0,0 +1,46 @@
+import type { CoreOptions, UriOptions, UrlOptions } from "request";
+
+declare class Pageclip {
+    constructor(token: string, options?: Pageclip.PageclipOptions);
+
+    fetch(bucketName?: string): Promise<Pageclip.Response>;
+    send(bucketName: string, data: Pageclip.SendData): Promise<Pageclip.Response>;
+    send(data: Pageclip.SendData): Promise<Pageclip.Response>;
+
+    private _token: string;
+    private _base64Token: string;
+    private _options: Pageclip.PageclipOptions;
+
+    private _getBucketName(bucketName?: string): string;
+    private _request(method: string, url: string, args?: unknown): Promise<Pageclip.Response>;
+    private _getRequestOptions(method: string, url: string, body?: unknown): CoreOptions & UriOptions & UrlOptions;
+    private _getHeaders(): Record<string, string>;
+}
+
+declare namespace Pageclip {
+    interface PageclipOptions {
+        baseURL?: string;
+    }
+
+    type SendData = Record<string, unknown> | Array<Record<string, unknown>>;
+
+    interface Item {
+        itemEid: string;
+        createdAt: string;
+        payload: Record<string, unknown>;
+    }
+
+    interface Error {
+        message: string;
+        property?: string;
+    }
+
+    interface Response {
+        status: number;
+        form: string;
+        data: Item[];
+        errors?: Error[];
+    }
+}
+
+export = Pageclip;

types/pageclip/package.json

@@ -0,0 +1,21 @@
+{
+    "private": true,
+    "name": "@types/pageclip",
+    "version": "1.0.9999",
+    "projects": [
+        "https://github.com/benogle/node-pageclip#readme"
+    ],
+    "devDependencies": {
+        "@types/pageclip": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Usman S. (Max Programming)",
+            "githubUsername": "max-programming"
+        }
+    ],
+    "dependencies": {
+        "@types/node": "^22.13.9999",
+        "@types/request": "^2.48.9999"
+    }
+}

types/pageclip/pageclip-tests.ts

@@ -0,0 +1,23 @@
+import Pageclip from "pageclip";
+
+const pageclip = new Pageclip("abc123ABC123abc123abc123abc12345");
+
+pageclip.send({ some: "data" }).then((response) => {
+    console.log(response.status, response.form, response.data);
+});
+
+pageclip.send([{ some: "data" }, { some: "otherdata" }]).then((response) => {
+    console.log(response.status, response.form, response.data);
+});
+
+pageclip.send("mailinglist", { email: "[email protected]" }).then((response) => {
+    console.log(response.status, response.form, response.data);
+});
+
+pageclip.fetch().then((response) => {
+    console.log(response.status, response.form, response.data);
+});
+
+pageclip.fetch("mailinglist").then((response) => {
+    console.log(response.status, response.form, response.data);
+});

types/pageclip/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": ["es6"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": ["index.d.ts", "pageclip-tests.ts"]
+}