@pinata/sdk 2.0.0 → 3.0.0

package/types/commands/data/pinList/pinList.d.ts

@@ -1,45 +0,0 @@
-import { PinataConfig } from '../../..';
-export interface PinataPinRegion {
-    regionId: string;
-    currentReplicationCount: number;
-    desiredReplicationCount: number;
-}
-export interface PinataMetadata {
-    [key: string]: string | number | null;
-}
-export interface PinataMetadataFilter {
-    name?: string | undefined;
-    keyvalues: {
-        [key: string]: {
-            value: string | number | null;
-            op: string;
-        };
-    };
-}
-export interface PinataPin {
-    id: string | number;
-    ipfs_pin_hash: string;
-    size: number;
-    user_id: string | number;
-    date_pinned: string;
-    date_unpinned: string | null;
-    metadata: PinataMetadata;
-    regions: PinataPinRegion[];
-}
-export declare type PinataPinListFilterOptions = {
-    hashContains?: string | undefined;
-    pinStart?: string | undefined;
-    pinEnd?: string | undefined;
-    unpinStart?: string | undefined;
-    unpinEnd?: string | undefined;
-    pinSizeMin?: number | undefined;
-    pinSizeMax?: number | undefined;
-    status?: string | undefined;
-    pageLimit?: number | undefined;
-    pageOffset?: number | undefined;
-    metadata?: PinataMetadataFilter | undefined;
-};
-export interface PinataPinListResponse {
-    rows: PinataPin[];
-}
-export default function pinList(config: PinataConfig, filters?: PinataPinListFilterOptions): Promise<PinataPinListResponse>;

package/types/commands/data/pinList/queryBuilder.d.ts

@@ -1 +0,0 @@
-export default function queryBuilder(baseUrl: string, filters?: any): string;

package/types/commands/data/testAuthentication.d.ts

@@ -1,5 +0,0 @@
-import { PinataConfig } from '../..';
-export interface PinataTestAuthenticationResponse {
-    authenticated: boolean;
-}
-export default function testAuthentication(config: PinataConfig): Promise<PinataTestAuthenticationResponse>;

package/types/commands/data/userPinnedDataTotal.d.ts

@@ -1,2 +0,0 @@
-import { PinataConfig } from '../..';
-export default function userPinnedDataTotal(config: PinataConfig): Promise<number>;

package/types/commands/pinning/hashMetadata.d.ts

@@ -1,3 +0,0 @@
-import { PinataConfig } from '../..';
-import { PinataMetadata } from '../data/pinList/pinList';
-export default function hashMetadata(config: PinataConfig, ipfsPinHash: string, metadata: PinataMetadata): Promise<any>;

package/types/commands/pinning/hashPinPolicy.d.ts

@@ -1,9 +0,0 @@
-/**
- * Hash Pin Policy
- * @param {string} pinataApiKey
- * @param {string} pinataSecretApiKey
- * @param {*} ipfsPinHash
- * @param {*} newPinPolicy
- * @returns {Promise<unknown>}
- */
-export default function hashPinPolicy(config: any, ipfsPinHash: any, newPinPolicy: any): Promise<unknown>;

package/types/commands/pinning/index.d.ts

@@ -1,8 +0,0 @@
-export * from './pinJobs/pinJobs';
-export * from './pinJobs/queryBuilder';
-export * from './hashMetadata';
-export * from './pinByHash';
-export * from './pinFileToIPFS';
-export * from './pinFromFS';
-export * from './pinJSONToIPFS';
-export * from './unpin';

package/types/commands/pinning/pinByHash.d.ts

@@ -1,14 +0,0 @@
-import { PinataConfig } from '../..';
-import { PinataOptions } from './pinFileToIPFS';
-import { PinataMetadata } from '../data/pinList/pinList';
-export interface PinataPinByHashPinOptions {
-    pinataMetadata?: PinataMetadata;
-    pinataOptions?: PinataOptions;
-}
-export interface PinataPinByHashResponse {
-    id: number | string;
-    ipfsHash: string;
-    status: string;
-    name: string;
-}
-export default function pinByHash(config: PinataConfig, hashToPin: string, options: any): Promise<any>;

package/types/commands/pinning/pinFileToIPFS.d.ts

@@ -1,25 +0,0 @@
-import NodeFormData from 'form-data';
-import { PinataConfig, PinataMetadata } from '../..';
-export interface PinataPinPolicyItem {
-    id: string;
-    desiredReplicationCount: number;
-}
-export interface PinataOptions {
-    hostNodes?: string[] | undefined;
-    cidVersion?: 0 | 1;
-    wrapWithDirectory?: boolean;
-    customPinPolicy?: {
-        regions: PinataPinPolicyItem[];
-    };
-}
-export interface PinataPinResponse {
-    IpfsHash: string;
-    PinSize: number;
-    Timestamp: string;
-}
-export interface PinataPinOptions {
-    pinataMetadata?: PinataMetadata;
-    pinataOptions?: PinataOptions | undefined;
-}
-export declare function uploadToIPFS(config: PinataConfig, data: NodeFormData, options?: PinataPinOptions): Promise<PinataPinResponse>;
-export default function pinFileToIPFS(config: PinataConfig, readStream: any, options?: PinataPinOptions): Promise<PinataPinResponse>;

package/types/commands/pinning/pinFromFS.d.ts

@@ -1,3 +0,0 @@
-import { PinataConfig } from '../..';
-import { PinataPinOptions, PinataPinResponse } from './pinFileToIPFS';
-export default function pinFromFS(config: PinataConfig, sourcePath: string, options?: PinataPinOptions): Promise<PinataPinResponse>;

package/types/commands/pinning/pinJSONToIPFS.d.ts

@@ -1,3 +0,0 @@
-import { PinataConfig } from '../..';
-import { PinataPinOptions, PinataPinResponse } from './pinFileToIPFS';
-export default function pinJSONToIPFS(config: PinataConfig, body: any, options?: PinataPinOptions): Promise<PinataPinResponse>;

package/types/commands/pinning/pinJobs/pinJobs.d.ts

@@ -1,20 +0,0 @@
-import { PinataConfig } from '../../..';
-export interface PinataPinJobsResponseRow {
-    id: number | string;
-    ipfs_pin_hash: string;
-    date_queued: string;
-    name: string | undefined | null;
-    status: string;
-}
-export interface PinataPinJobsResponse {
-    count: number;
-    rows: PinataPinJobsResponseRow[];
-}
-export interface PinataPinJobsFilterOptions {
-    sort: 'ASC' | 'DESC';
-    status?: string | undefined;
-    ipfs_pin_hash?: string | undefined;
-    limit?: number | undefined;
-    offset?: number | undefined;
-}
-export default function pinJobs(config: PinataConfig, filters?: PinataPinJobsFilterOptions): Promise<PinataPinJobsResponse>;

package/types/commands/pinning/pinJobs/queryBuilder.d.ts

@@ -1 +0,0 @@
-export default function queryBuilder(baseUrl: string, filters?: any): string;

package/types/commands/pinning/unpin.d.ts

@@ -1,2 +0,0 @@
-import { PinataConfig } from '../..';
-export default function unpin(config: PinataConfig, hashToUnpin: string): Promise<unknown>;

package/types/commands/pinning/userPinPolicy.d.ts

@@ -1,8 +0,0 @@
-/**
- * User Pin Policy
- * @param {string} pinataApiKey
- * @param {string} pinataSecretApiKey
- * @param {*} newPinPolicy
- * @returns {Promise<unknown>}
- */
-export default function userPinPolicy(config: any, newPinPolicy: any): Promise<unknown>;

package/types/constants.d.ts

@@ -1,2 +0,0 @@
-export declare const baseUrl = "https://api.pinata.cloud";
-export declare const ERROR_NO_CREDENTIALS_PROVIDED = "No credentials provided! Please provide your pinata api key and pinata secret api key or your pinata JWT key as an argument when you start this script";

package/types/index.d.ts

@@ -1,38 +0,0 @@
-import { PinataPinByHashPinOptions } from './commands/pinning/pinByHash';
-import { PinataPinOptions } from './commands/pinning/pinFileToIPFS';
-import { PinataPinJobsFilterOptions } from './commands/pinning/pinJobs/pinJobs';
-import { PinataMetadata, PinataPinListFilterOptions } from './commands/data/pinList/pinList';
-export interface PinataConfig {
-    pinataApiKey?: string;
-    pinataSecretApiKey?: string;
-    pinataJWTKey?: string;
-}
-declare class PinataClient {
-    config: PinataConfig;
-    constructor(pinataApiKey?: string | PinataConfig, pinataSecretApiKey?: string);
-    pinByHash(hashToPin: string, options?: PinataPinByHashPinOptions): Promise<any>;
-    hashMetadata(ipfsPinHash: string, metadata: PinataMetadata): Promise<any>;
-    pinFileToIPFS(readableStream: any, options?: PinataPinOptions): Promise<import("./commands/pinning").PinataPinResponse>;
-    pinFromFS(sourcePath: string, options?: PinataPinOptions): Promise<import("./commands/pinning").PinataPinResponse>;
-    pinJSONToIPFS(body: any, options?: PinataPinOptions): Promise<import("./commands/pinning").PinataPinResponse>;
-    pinJobs(filters?: PinataPinJobsFilterOptions): Promise<import("./commands/pinning").PinataPinJobsResponse>;
-    unpin(hashToUnpin: string): Promise<unknown>;
-    pinList(filters: PinataPinListFilterOptions): Promise<import("./commands/data").PinataPinListResponse>;
-    getFilesByCount(filters: PinataPinListFilterOptions, maxCount?: number): {
-        [Symbol.asyncIterator]: () => {
-            next(): Promise<{
-                value: import("./commands/data").PinataPin;
-                done: boolean;
-            }>;
-            return(): Promise<{
-                value: number;
-                done: boolean;
-            }>;
-        };
-    };
-    testAuthentication(): Promise<import("./commands/data").PinataTestAuthenticationResponse>;
-    userPinnedDataTotal(): Promise<number>;
-}
-export * from './commands/data';
-export * from './commands/pinning';
-export default PinataClient;

package/types/util/errorResponse.d.ts

@@ -1 +0,0 @@
-export declare const handleError: (error: any) => any;

package/types/util/validators.d.ts

@@ -1,37 +0,0 @@
-import { PinataConfig } from '..';
-export interface axiosHeaders {
-    maxContentLength: number;
-    maxBodyLength: number;
-    headers: {
-        [key: string]: any;
-    };
-    withCredentials?: boolean;
-}
-export declare function validateApiKeys(pinataApiKey?: string, pinataSecretApiKey?: string): void;
-export declare function createConfigForAxiosHeaders(config: PinataConfig): {
-    withCredentials: boolean;
-    headers: {
-        pinata_api_key: string;
-        pinata_secret_api_key: string;
-        Authorization?: undefined;
-    };
-} | {
-    headers: {
-        Authorization: string;
-        pinata_api_key?: undefined;
-        pinata_secret_api_key?: undefined;
-    };
-    withCredentials?: undefined;
-};
-export declare function createConfigForAxiosHeadersWithFormData(config: PinataConfig, boundaryValue: string): axiosHeaders;
-export declare function validateHostNodes(hostNodes: any): void;
-export declare function validateMetadata(metadata: any): void;
-export declare function validatePinPolicyStructure(pinPolicy: {
-    regions: any[];
-}): void;
-export declare function validatePinataOptions(options: {
-    cidVersion?: number;
-    wrapWithDirectory?: boolean;
-    hostNodes?: any;
-    customPinPolicy?: any;
-}): void;

package/webpack.config.js

@@ -1,58 +0,0 @@
-const webpack = require('webpack');
-const path = require('path');
-
-const libraryName = 'pinata-sdk';
-
-module.exports = (env) => {
-    let outputFile, mode;
-
-    if (env === 'build') {
-        mode = 'production';
-
-        outputFile = libraryName + '.min.js';
-    } else {
-        mode = 'development';
-        outputFile = libraryName + '.js';
-    }
-    return {
-        mode: mode,
-        entry: ['babel-polyfill', __dirname + '/src/index.ts'],
-        devtool: 'inline-source-map',
-        output: {
-            path: __dirname + '/lib',
-            filename: outputFile,
-            library: libraryName,
-            libraryTarget: 'umd',
-            umdNamedDefine: true,
-            globalObject: "typeof self !== 'undefined' ? self : this"
-        },
-        module: {
-            rules: [
-                {
-                    test: /\.ts?$/,
-                    loader: 'babel-loader',
-                    exclude: /(node_modules|bower_components)/
-             },
-                // {
-                //     test: /\.ts?$/,
-                //     loader: 'eslint-loader',
-                //     exclude: /node_modules/,
-                      
-                // }
-            ]
-        },
-        target: 'node',
-        node: {
-            process: false
-        },
-        plugins: [
-            new webpack.DefinePlugin({
-                'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
-            })
-        ],
-        resolve: {
-            modules: [path.resolve('./node_modules'), path.resolve('./src')],
-            extensions: ['.json', '.js', '.ts']
-        }
-    };
-};