@pinata/sdk 2.0.0 → 3.0.0

package/index.d.ts

@@ -0,0 +1,9 @@
+export * from "pinata";
+
+/**
+ * @deprecated The v2 default export was removed. Use the named export instead:
+ * `import { PinataSDK } from "@pinata/sdk"` with `new PinataSDK({ pinataJwt })`.
+ * Calling this throws.
+ */
+declare const LegacyPinataSDK: (...args: unknown[]) => never;
+export default LegacyPinataSDK;

package/index.js

@@ -0,0 +1,6 @@
+"use strict";
+
+const pinata = require("pinata");
+const LegacyPinataSDK = require("./legacy.js");
+
+module.exports = Object.assign(LegacyPinataSDK, pinata);

package/index.mjs

@@ -0,0 +1,4 @@
+import LegacyPinataSDK from "./legacy.js";
+
+export * from "pinata";
+export default LegacyPinataSDK;

package/legacy.js

@@ -0,0 +1,15 @@
+"use strict";
+
+// v2 of @pinata/sdk exported a constructor as the default export
+// (`new pinataSDK(key, secret)`). v3 is the `pinata` package, so calling the
+// old default export throws a migration hint instead of a cryptic TypeError.
+function LegacyPinataSDK() {
+	throw new Error(
+		"@pinata/sdk v3 is an alias of the `pinata` package and the v2 API has been removed. " +
+			"Use `const { PinataSDK } = require('@pinata/sdk')` with `new PinataSDK({ pinataJwt })`, " +
+			"or pin `@pinata/sdk@2` to keep the old API. " +
+			"Migration guide: https://github.com/PinataCloud/pinata/tree/main/packages/sdk-alias#migrating-from-v2",
+	);
+}
+
+module.exports = LegacyPinataSDK;

package/package.json

@@ -1,86 +1,60 @@
 {
-    "name": "@pinata/sdk",
-    "version": "2.0.0",
-    "description": "Official SDK for the Pinata IPFS platform",
-    "main": "lib/pinata-sdk.js",
-    "types": "types/index.d.ts",
-    "scripts": {
-        "prepare": "husky install",
-        "build": "npm run build-dev && npm run build-prod && npm run test && tsc",
-        "build-dev": "webpack --env dev",
-        "build-prod": "webpack --env build",
-        "coverage": "jest --coverage",
-        "dev": "webpack --progress --colors --watch --env dev",
-        "html": "open coverage/index.html",
-        "lint": "eslint src --quiet ",
-        "lint:fix": "eslint src test --fix",
-        "test": "./node_modules/.bin/jest --env=node",
-        "repl": "node -i -e \"$(< ./lib/pinata-sdk.js)\""
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/PinataCloud/Pinata-SDK.git"
-    },
-    "keywords": [
-        "webpack",
-        "es6",
-        "starter",
-        "library",
-        "universal",
-        "umd",
-        "commonjs"
-    ],
-    "author": "Matt Ober",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/PinataCloud/Pinata-SDK/issues"
-    },
-    "homepage": "https://github.com/PinataCloud/Pinata-SDK",
-    "devDependencies": {
-        "@babel/cli": "^7.8.4",
-        "@babel/core": "^7.8.4",
-        "@babel/plugin-transform-runtime": "^7.19.1",
-        "@babel/preset-env": "^7.19.4",
-        "@babel/preset-typescript": "^7.18.6",
-        "@babel/register": "^7.8.3",
-        "@types/jest": "^29.2.0",
-        "@types/node": "^15.6.1",
-        "@typescript-eslint/eslint-plugin": "^5.41.0",
-        "@typescript-eslint/parser": "^5.41.0",
-        "acorn": "^7.1.0",
-        "babel-eslint": "^10.0.3",
-        "babel-loader": "^8.0.6",
-        "babel-plugin-add-module-exports": "^1.0.2",
-        "babel-polyfill": "^6.26.0",
-        "eslint": "^8.26.0",
-        "eslint-loader": "^3.0.3",
-        "husky": "^8.0.0",
-        "jest": "^25.1.0",
-        "source-map-loader": "^4.0.1",
-        "typescript": "^4.8.4",
-        "uglifyjs-webpack-plugin": "^2.2.0",
-        "webpack": "^4.41.6",
-        "webpack-cli": "^3.3.11"
-    },
-    "dependencies": {
-        "axios": "^0.21.1",
-        "base-path-converter": "^1.0.2",
-        "form-data": "^2.3.3",
-        "is-ipfs": "^0.6.0",
-        "path": "^0.12.7"
-    },
-    "jest": {
-        "collectCoverage": true,
-        "coverageReporters": [
-            "text",
-            "html"
-        ],
-        "moduleFileExtensions": [
-            "ts",
-            "tsx",
-            "js",
-            "jsx",
-            "json"
-        ]
-    }
+	"name": "@pinata/sdk",
+	"version": "3.0.0",
+	"description": "Alias of the official Pinata SDK (`pinata`)",
+	"main": "./index.js",
+	"module": "./index.mjs",
+	"types": "./index.d.ts",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.mjs",
+			"require": "./index.js"
+		},
+		"./react": {
+			"types": "./react/index.d.ts",
+			"import": "./react/index.mjs",
+			"require": "./react/index.js"
+		}
+	},
+	"files": [
+		"index.js",
+		"index.mjs",
+		"index.d.ts",
+		"legacy.js",
+		"react"
+	],
+	"scripts": {
+		"test": "node --test test/*.test.cjs test/*.test.mjs"
+	},
+	"dependencies": {
+		"pinata": "^2.5.7"
+	},
+	"peerDependencies": {
+		"react": ">=16.8.0",
+		"react-dom": ">=16.8.0"
+	},
+	"peerDependenciesMeta": {
+		"react": {
+			"optional": true
+		},
+		"react-dom": {
+			"optional": true
+		}
+	},
+	"engines": {
+		"node": ">=20"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/PinataCloud/pinata.git",
+		"directory": "packages/sdk-alias"
+	},
+	"homepage": "https://docs.pinata.cloud/sdk",
+	"bugs": {
+		"url": "https://github.com/PinataCloud/pinata/issues"
+	},
+	"keywords": ["pinata", "ipfs", "sdk"],
+	"author": "Pinata Cloud Technologies",
+	"license": "MIT"
 }

package/react/index.d.ts

@@ -0,0 +1 @@
+export * from "pinata/react";

package/react/index.js

@@ -0,0 +1,3 @@
+"use strict";
+
+module.exports = require("pinata/react");

package/react/index.mjs

@@ -0,0 +1 @@
+export * from "pinata/react";

package/.babelrc

@@ -1,5 +0,0 @@
-{
-  "presets": ["@babel/preset-typescript", ["@babel/env", { "modules": "commonjs" , "useBuiltIns": "usage"}]  ],
-  "plugins": ["add-module-exports", "@babel/plugin-transform-runtime"]
-}
-

package/.editorconfig

@@ -1,12 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = LF
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

package/.eslintrc

@@ -1,173 +0,0 @@
-{
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
-  "root": true,
-  "env": {
-    "browser": true,
-    "es6": true,
-    "node": true,
-    "jest": true
-  },
-
-  "globals": {
-    "document": false,
-    "escape": false,
-    "navigator": false,
-    "unescape": false,
-    "window": false,
-    "describe": true,
-    "before": true,
-    "it": true,
-    "expect": true,
-    "sinon": true    
-  },
-
-
-
-  "rules": {
-    "block-scoped-var": 2,
-    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
-    "comma-dangle": [2, "never"],
-    "comma-spacing": [2, { "before": false, "after": true }],
-    "comma-style": [2, "last"],
-    "complexity": 0,
-    "consistent-return": 2,
-    "consistent-this": 0,
-    "curly": [2, "multi-line"],
-    "default-case": 0,
-    "dot-location": [2, "property"],
-    "dot-notation": 0,
-    "eol-last": 2,
-    "eqeqeq": [2, "allow-null"],
-    "func-names": 0,
-    "func-style": 0,
-    "generator-star-spacing": [2, "both"],
-    "guard-for-in": 0,
-    "handle-callback-err": [2, "^(err|error|anySpecificError)$" ],
-    "key-spacing": [2, { "beforeColon": false, "afterColon": true }],
-    "keyword-spacing": [2, {"before": true, "after": true}],
-    "linebreak-style": 0,
-    "max-depth": 0,
-    "max-nested-callbacks": 0,
-    "max-params": 0,
-    "max-statements": 0,
-    "new-cap": [2, { "newIsCap": true, "capIsNew": false }],
-    "new-parens": 2,
-    "no-alert": 0,
-    "no-array-constructor": 2,
-    "no-bitwise": 0,
-    "no-caller": 2,
-    "no-catch-shadow": 0,
-    "no-cond-assign": 2,
-    "no-console": 0,
-    "no-constant-condition": 0,
-    "no-continue": 0,
-    "no-control-regex": 2,
-    "no-debugger": 2,
-    "no-delete-var": 2,
-    "no-div-regex": 0,
-    "no-dupe-args": 2,
-    "no-dupe-keys": 2,
-    "no-duplicate-case": 2,
-    "no-else-return": 2,
-    "no-empty": 0,
-    "no-empty-character-class": 2,
-    "no-eq-null": 0,
-    "no-eval": 2,
-    "no-ex-assign": 2,
-    "no-extend-native": 2,
-    "no-extra-bind": 2,
-    "no-extra-boolean-cast": 2,
-    "no-extra-parens": 0,
-    "no-extra-semi": 0,
-    "no-extra-strict": 0,
-    "no-fallthrough": 2,
-    "no-floating-decimal": 2,
-    "no-func-assign": 2,
-    "no-implied-eval": 2,
-    "no-inline-comments": 0,
-    "no-inner-declarations": [2, "functions"],
-    "no-invalid-regexp": 2,
-    "no-irregular-whitespace": 2,
-    "no-iterator": 2,
-    "no-label-var": 2,
-    "no-labels": 2,
-    "no-lone-blocks": 0,
-    "no-lonely-if": 0,
-    "no-loop-func": 0,
-    "no-mixed-requires": 0,
-    "no-mixed-spaces-and-tabs": [2, false],
-    "no-multi-spaces": 2,
-    "no-multi-str": 2,
-    "no-multiple-empty-lines": [2, { "max": 1 }],
-    "no-native-reassign": 2,
-    "no-negated-in-lhs": 2,
-    "no-nested-ternary": 0,
-    "no-new": 2,
-    "no-new-func": 2,
-    "no-new-object": 2,
-    "no-new-require": 2,
-    "no-new-wrappers": 2,
-    "no-obj-calls": 2,
-    "no-octal": 2,
-    "no-octal-escape": 2,
-    "no-path-concat": 0,
-    "no-plusplus": 0,
-    "no-process-env": 0,
-    "no-process-exit": 0,
-    "no-proto": 2,
-    "no-redeclare": 2,
-    "no-regex-spaces": 2,
-    "no-reserved-keys": 0,
-    "no-restricted-modules": 0,
-    "no-return-assign": 2,
-    "no-script-url": 0,
-    "no-self-compare": 2,
-    "no-sequences": 2,
-    "no-shadow": 0,
-    "no-shadow-restricted-names": 2,
-    "no-spaced-func": 2,
-    "no-sparse-arrays": 2,
-    "no-sync": 0,
-    "no-ternary": 0,
-    "no-throw-literal": 2,
-    "no-trailing-spaces": 2,
-    "no-undef": 2,
-    "no-undef-init": 2,
-    "no-undefined": 0,
-    "no-underscore-dangle": 0,
-    "no-unneeded-ternary": 2,
-    "no-unreachable": 2,
-    "no-unused-expressions": 0,
-    "no-unused-vars": [2, { "vars": "all", "args": "none" }],
-    "no-use-before-define": 2,
-    "no-var": 0,
-    "no-void": 0,
-    "no-warning-comments": 0,
-    "no-with": 2,
-    "one-var": 0,
-    "operator-assignment": 0,
-    "operator-linebreak": [2, "after"],
-    "padded-blocks": 0,
-    "quote-props": 0,
-    "quotes": [2, "single", "avoid-escape"],
-    "semi": [2, "always"],
-    "semi-spacing": 0,
-    "sort-vars": 0,
-    "space-before-blocks": [2, "always"],
-    "space-before-function-paren": [2, {"anonymous": "always", "named": "never"}],
-    "space-in-brackets": 0,
-    "space-in-parens": [2, "never"],
-    "space-infix-ops": 2,
-    "space-unary-ops": [2, { "words": true, "nonwords": false }],
-    "strict": 0,
-    "use-isnan": 2,
-    "valid-jsdoc": 0,
-    "valid-typeof": 2,
-    "vars-on-top": 2,
-    "wrap-iife": [2, "any"],
-    "wrap-regex": 0,
-    "yoda": [2, "never"]
-  }
-}

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run lint:fix
-npm test
-npm build

package/.nvmrc

@@ -1 +0,0 @@
-v14.0

package/.travis.yml

@@ -1,5 +0,0 @@
-language: node_js
-node_js:
-  - "node"
-  - "7"
-  - "6"