@pinata/sdk 1.2.0 → 2.0.0-beta.0

package/test/commands/data/pinlist-sample-api.ts

@@ -0,0 +1,540 @@
+import { baseUrl } from '../../../src/constants';
+
+export const fakeHeaders = {
+    headers: {
+        pinata_api_key: 'anykey',
+        pinata_secret_api_key: 'anysecret'
+    },
+    withCredentials: true
+};
+export const statusOk = {
+    status: 200
+};
+export const APIData = {
+    rows: [
+        {
+            id: 'b0fbdba0-de78-4736-9211-632633deb7be',
+            ipfs_pin_hash: 'QmRLzdxyiT3waRz1i2J1CU4w868VAkcVpAcQ5vAWEmcNHD',
+            size: 52960,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:46:53.843Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin20.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'e5a59111-760c-4f24-8b98-fbb6918d578f',
+            ipfs_pin_hash: 'QmQ7M5otCbU3GdRizPNrktBfjP2kxxWMCAsT8X83GfQM6h',
+            size: 35318,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:46:44.534Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin19.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'efb2394a-ba19-4df7-9042-7c30e64cd377',
+            ipfs_pin_hash: 'QmRz8F1KiLfw8SHfshhVjjwnSGjQrqspYjHUSBYFhrF6rD',
+            size: 66956,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:46:33.390Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin18.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '1b004592-e84b-4cb3-81ec-07850ba8186b',
+            ipfs_pin_hash: 'QmauuvrS18r487tLtFHjZoqXFc3xrZLDBQqnpKycs9LPau',
+            size: 84599,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:46:24.204Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin17.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'e1cb1fe1-9d82-4553-90b2-8888d998ff54',
+            ipfs_pin_hash: 'QmV9S3Jx1abuA13VwD44CKRRnD7mdhbP4HL9HvjZdYpMZm',
+            size: 360611,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:46:14.291Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin16.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '38c0008a-5996-4166-b409-fe1fb699b62f',
+            ipfs_pin_hash: 'QmcC1qN1ALkeTrd4wVPgP2R6UsTKBRb7PNL91GwSUYAc2q',
+            size: 329724,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:56.523Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin15.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '90cddd06-5531-4234-adf5-680fd7c59a62',
+            ipfs_pin_hash: 'QmVMM2ogFUFZMnRtcsAj4zgBbAv8MYKRetD3iMNXjHWDqh',
+            size: 49229,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:43.837Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin14.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '40aff586-32a5-4142-9973-d35a0d596941',
+            ipfs_pin_hash: 'QmWTnoGJ7AP2c3USkX42SpG4YdiiWNuQNvcpxR3uy7ZWfM',
+            size: 76626,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:33.758Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin13.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '38814347-144f-4140-9838-f7fce4d11f21',
+            ipfs_pin_hash: 'QmZmUm6smWQqSquvWJr51e14fC6nT4HHsCWXcWKXnhNQH9',
+            size: 139412,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:23.063Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin12.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '381335b2-f64e-4c95-b5e6-63a6110bf639',
+            ipfs_pin_hash: 'QmVcwfTjRki1o7WvCkfMVVfv9oRj3kaFnfWLq62TuAEqD9',
+            size: 146257,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:12.268Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin11.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'b1ce6263-b1fb-4831-8c74-6f71b31e72c6',
+            ipfs_pin_hash: 'QmSWCZLFjGuWYjxDCvPcyqwA35kdH5RYExex3U2DXrXcfH',
+            size: 89932,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:45:02.143Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin10.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '65f89885-9a9c-47f5-8442-63942296f3f3',
+            ipfs_pin_hash: 'QmZpTaAAxUdscD6mMkYADYHVRbekhHvXyL6MCCRc4hcM4t',
+            size: 121532,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:44:50.487Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin9.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'd74055a9-4b6b-439e-99c0-b4b908d027c7',
+            ipfs_pin_hash: 'QmdKakBkbCpdeLTf3NMR382it4kZdo848FTvbSGNmmAmSi',
+            size: 80314,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:44:38.972Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin8.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '53a56f84-89c7-4947-979e-8f6e8d584151',
+            ipfs_pin_hash: 'QmfLTuCn3iyhgL6iyZqGNovnAkv5ip5oAPFWmPTYXkmFgb',
+            size: 115132,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:44:28.357Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin7.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '7ce5f037-b991-4bcb-b888-6f1dd2f4005c',
+            ipfs_pin_hash: 'QmaDVCBZ9sMQ7AFAqGqWqLymcetJBMsH9TuxwmqqZaVRss',
+            size: 68293,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:44:16.939Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin6.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'b6d9d849-51e4-4ea4-ae01-8c1cc000d0ad',
+            ipfs_pin_hash: 'QmNsq42HSV4CAvNLuwe9ZjPkUYQoGiwxXdfyRRLx7Njd7f',
+            size: 82560,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:44:05.743Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin5.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: 'ae45ab56-aa22-4ffd-8116-96a5b6bc6fc8',
+            ipfs_pin_hash: 'QmT8fjVvMZKEDgPZ3JcYqsZvdZLB1S8qT3FE777BE1R3RL',
+            size: 38428,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:43:47.227Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin4.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '86ee7b32-b723-4ef0-97ef-7efb4386ebcf',
+            ipfs_pin_hash: 'QmZCZwCqKG8tsLCeUCCeevdKAQJy53uLCwDuXptg1E9xUa',
+            size: 113338,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:42:09.658Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin3.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '76bb512a-52de-41ab-9008-22b0b0965a59',
+            ipfs_pin_hash: 'QmSgwD6mjitrh59koPLpswMtwUZnuASi7durphHuXUQnex',
+            size: 23661,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:41:57.767Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin2.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        },
+        {
+            id: '0b5ba870-1230-47ba-8298-6de92978ff3f',
+            ipfs_pin_hash: 'QmNdoq9LuNmKYCKTWsCaowLWCZxv6K5payarU8i5TB4Bo6',
+            size: 6850,
+            user_id: '6002b716-edbd-40ee-8f64-c50e452ccc3a',
+            date_pinned: '2022-10-05T22:41:45.109Z',
+            date_unpinned: null,
+            metadata: {
+                name: 'pin1.png',
+                keyvalues: null
+            },
+            regions: [
+                {
+                    regionId: 'FRA1',
+                    currentReplicationCount: 0,
+                    desiredReplicationCount: 1
+                },
+                {
+                    regionId: 'NYC1',
+                    currentReplicationCount: 1,
+                    desiredReplicationCount: 1
+                }
+            ]
+        }
+    ]
+};
+
+export const pinListAxiosMockPages = {
+    firstPage: {
+        url: `${baseUrl}/data/pinList?includeCount=false&status=pinned&pageLimit=10&`,
+        headers: fakeHeaders,
+        response: {
+            ...statusOk,
+            data: {
+                rows: APIData.rows.slice(0, 10)
+            }
+        }
+    },
+    secondPage: {
+        url: `${baseUrl}/data/pinList?includeCount=false&status=pinned&pageLimit=10&pageOffset=10&`,
+        headers: fakeHeaders,
+        response: {
+            ...statusOk,
+            data: {
+                rows: APIData.rows.slice(10, 20)
+            }
+        }
+    },
+    thirdPageEmpty: {
+        url: `${baseUrl}/data/pinList?includeCount=false&status=pinned&pageLimit=10&pageOffset=20&`,
+        headers: fakeHeaders,
+        response: {
+            ...statusOk,
+            data: {
+                rows: []
+            }
+        }
+    },
+    firstPageEmpty: {
+        url: `${baseUrl}/data/pinList?includeCount=false&status=pinned&pageLimit=10&`,
+        headers: fakeHeaders,
+
+        response: {
+            ...statusOk,
+            data: {
+                rows: []
+            }
+        }
+    }
+};

package/test/commands/data/testAuthentication.test.ts

@@ -0,0 +1,34 @@
+import axios from 'axios';
+import testAuthentication from '../../../src/commands/data/testAuthentication';
+
+jest.mock('axios');
+
+test('Result other than 200 status is returned', () => {
+    const badStatus = {
+        status: 700
+    };
+    (axios.get as jest.Mock).mockResolvedValue(badStatus);
+    expect.assertions(1);
+    return expect(testAuthentication({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual(
+        Error(`unknown server response while authenticating: ${badStatus}`)
+    );
+});
+
+test('200 status is returned', () => {
+    const goodStatus = {
+        status: 200
+    };
+    (axios.get as jest.Mock).mockResolvedValue(goodStatus);
+    expect.assertions(1);
+    return expect(testAuthentication({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).resolves.toEqual({
+        authenticated: true
+    });
+});
+
+test('Rejection handled', () => {
+    (axios.get as jest.Mock).mockRejectedValue('test error');
+    expect.assertions(1);
+    return expect(testAuthentication({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual(
+        'test error'
+    );
+});

package/test/commands/data/userPinnedDataTotal.test.ts

@@ -0,0 +1,29 @@
+import axios from 'axios';
+import userPinnedDataTotal from '../../../src/commands/data/userPinnedDataTotal';
+
+jest.mock('axios');
+
+test('Result other than 200 status is returned', () => {
+    const badStatus = {
+        status: 700
+    };
+    (axios.get as jest.Mock).mockResolvedValue(badStatus);
+    expect.assertions(1);
+    expect(userPinnedDataTotal({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual(Error(`unknown server response while attempting to retrieve pinned data total: ${badStatus}`));
+});
+
+test('200 status is returned', () => {
+    const goodStatus = {
+        status: 200,
+        data: 'testData'
+    };
+    (axios.get as jest.Mock).mockResolvedValue(goodStatus);
+    expect.assertions(1);
+    expect(userPinnedDataTotal({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).resolves.toEqual(goodStatus.data);
+});
+
+test('Rejection handled', () => {
+    (axios.get as jest.Mock).mockRejectedValue('test error');
+    expect.assertions(1);
+    expect(userPinnedDataTotal({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual('test error');
+});

package/test/commands/pinning/hashMetadata.test.ts

@@ -0,0 +1,76 @@
+import axios from 'axios';
+import hashMetadata from '../../../src/commands/pinning/hashMetadata';
+
+jest.mock('axios');
+
+//common values
+const badHash = 'test';
+const goodHash = 'Qma6e8dovfLyiG2UUfdkSHNPAySzrWLX9qVXb44v1muqcp';
+const metadata = {
+    name: 'testname',
+    keyvalues: {
+        newKey: 'newValue'
+    }
+};
+
+const metadataTwo = {
+    name: 'testname',
+    keyvalues: {
+        newKey: 'newValue',
+        secondKey: 'secondValue'
+    }
+};
+
+test('No ipfsPinHash value provided should error', () => {
+    expect(() => {
+        hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, null, metadata);
+    }).toThrow();
+});
+
+test('Invalid ipfsPinHash value is provided', () => {
+    expect(() => {
+        hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, badHash, metadata);
+    }).toThrow();
+});
+
+test('No metadata object provided should error', () => {
+    expect(() => {
+        hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, goodHash);
+    }).toThrow();
+});
+
+test('One keyvalue pair is added', () => {
+    const goodStatus = {
+        status: 200,
+        data: 'testData'
+    };
+    (axios.put as jest.Mock).mockResolvedValue(goodStatus);
+    expect.assertions(1);
+    expect(hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, goodHash, metadata)).resolves.toEqual(goodStatus.data);
+});
+
+test('Two keyvalue pairs is added', () => {
+    const goodStatus = {
+        status: 200,
+        data: 'testData'
+    };
+    (axios.put as jest.Mock).mockResolvedValue(goodStatus);
+    expect.assertions(1);
+    expect(hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, goodHash, metadataTwo)).resolves.toEqual(goodStatus.data);
+});
+
+test('Result other than 200 status is returned', () => {
+    const badStatus = {
+        status: 700
+    };
+    (axios.put as jest.Mock).mockResolvedValue(badStatus);
+    expect.assertions(1);
+    expect(hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, goodHash, metadata)).rejects.toEqual(Error(`unknown server response while changing pin policy for hash: ${badStatus}`));
+});
+
+test('Rejection handled', () => {
+    (axios.put as jest.Mock).mockRejectedValue('test error');
+    expect.assertions(1);
+    expect(hashMetadata({ pinataApiKey: 'test', pinataSecretApiKey: 'test' }, goodHash, metadata)).rejects.toEqual('test error');
+});
+