pinata 0.1.3 → 0.1.5

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Krasimir Tsonev
+Copyright (c) 2024 Pinata Cloud Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

package/README.md

@@ -1,32 +1,107 @@
 # Pinata
 
+![cover-image](https://docs.mypinata.cloud/ipfs/bafkreidv5iptnieh6eijei7enqc4mdhxpte3ries23heqf7s2hu3gdu6ru)
+
 The new all-in-one Pinata SDK
 
-## Installation
+## Quickstart
+
+[View the full documentation here](https://docs.pinata.cloud/sdk-beta/getting-started)
 
-Clone, install, and build
+### 1. Install
 
 ```bash
-git clone https://github.com/PinataCloud/pinata
-cd pinata
-npm install && npm run build
+npm i pinata
+```
+
+Import and initialize the SDK in your codebase with the following variables
+- [Pinata API Key JWT](https://docs.pinata.cloud/account-management/api-keys)
+- [Pinata Dedicated Gateway Domain](https://docs.pinata.cloud/gateways/dedicated-ipfs-gateways)
+
+```typescript
+import { PinataSDK } from "pinata";
+
+const pinata = new PinataSDK({
+  pinataJwt: "PINATA_JWT",
+  pinataGateway: "example-gateway.mypinata.cloud",
+});
+```
+
+<Note>The `PINATA_JWT` is a secret key, be sure to initialize the SDK in a secure environment and practice basic variable security practices. If you need to upload from a client environment, consider using signed JWTs</Note>
+
+### 2. Upload a File
+
+```typescript
+import { PinataSDK } from "pinata";
+
+const pinata = new PinataSDK({
+  pinataJwt: process.env.PINATA_JWT!,
+  pinataGateway: "example-gateway.mypinata.cloud",
+});
+
+async function main() {
+  try {
+    const file = new File(["hello"], "Testing.txt", { type: "text/plain" });
+    const upload = await pinata.upload.file(file);
+    console.log(upload);
+  } catch (error) {
+    console.log(error);
+  }
+}
+
+await main();
 ```
 
-Import into your project with the `dist` directory from build
+This will return an object like the following
 
 ```typescript
-import { PinataSDK } from "../dist"
+{
+  IpfsHash: "bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq",
+  PinSize: 5,
+  Timestamp: "2024-07-11T23:33:27.665Z",
+}
 ```
 
-## Initialization
+### 3. Retrieve a File
+
+Use the CID or `IpfsHash` from the upload to fetch a file
 
 ```typescript
-import { PinataSDK } from "../dist";
+import { PinataSDK } from "pinata";
 
 const pinata = new PinataSDK({
-  pinataJwt: `PINATA_JWT`,
-  pinataGateway: `example-sub-domain.mypinata.cloud`,
+  pinataJwt: process.env.PINATA_JWT!,
+  pinataGateway: "example-gateway.mypinata.cloud",
 });
+
+async function main() {
+  try {
+    const data = await pinata.gateways.get("bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq");
+    console.log(data)
+  } catch (error) {
+    console.log(error);
+  }
+}
+
+main();
+```
+
+[View the full documentation here](https://docs.pinata.cloud/sdk-beta/getting-started)
+
+## Developing
+
+```bash
+git clone https://github.com/PinataCloud/pinata
+cd pinata
+npm install
 ```
 
-## [Full Docs](https://docs.pinata.cloud/sdk-beta/getting-started)
+Run Build
+```bash
+npm run build
+```
+
+Run Tests
+```bash
+npm run test
+```

package/dist/index.d.mts

@@ -222,6 +222,14 @@ type GroupCIDOptions = {
     groupId: string;
     cids: string[];
 };
+type SignatureOptions = {
+    cid: string;
+    signature: string;
+};
+type SignatureResponse = {
+    cid: string;
+    signature: string;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -230,6 +238,7 @@ declare class PinataSDK {
     usage: Usage;
     keys: Keys;
     groups: Groups;
+    signatures: Signatures;
     constructor(config?: PinataConfig);
     testAuthentication(): Promise<AuthTestResponse>;
     unpin(files: string[]): Promise<UnpinResponse[]>;
@@ -369,5 +378,12 @@ declare class FilterGroups {
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
 }
+declare class Signatures {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    add(options: SignatureOptions): Promise<SignatureResponse>;
+    get(cid: string): Promise<SignatureResponse>;
+    delete(cid: string): Promise<string>;
+}
 
-export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };

package/dist/index.d.ts

@@ -222,6 +222,14 @@ type GroupCIDOptions = {
     groupId: string;
     cids: string[];
 };
+type SignatureOptions = {
+    cid: string;
+    signature: string;
+};
+type SignatureResponse = {
+    cid: string;
+    signature: string;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -230,6 +238,7 @@ declare class PinataSDK {
     usage: Usage;
     keys: Keys;
     groups: Groups;
+    signatures: Signatures;
     constructor(config?: PinataConfig);
     testAuthentication(): Promise<AuthTestResponse>;
     unpin(files: string[]): Promise<UnpinResponse[]>;
@@ -369,5 +378,12 @@ declare class FilterGroups {
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
 }
+declare class Signatures {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    add(options: SignatureOptions): Promise<SignatureResponse>;
+    get(cid: string): Promise<SignatureResponse>;
+    delete(cid: string): Promise<string>;
+}
 
-export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };

package/dist/index.js

@@ -1484,6 +1484,130 @@ var deleteGroup = async (config, options) => {
   }
 };
 
+// src/core/signatures/addSignature.ts
+var addSignature = async (config, options) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  const data = JSON.stringify({
+    signature: options.signature
+  });
+  try {
+    const request = await fetch(
+      `https://api.pinata.cloud/v3/ipfs/signature/${options.cid}`,
+      {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${config?.pinataJwt}`
+        },
+        body: data
+      }
+    );
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError("Authentication failed", request.status, errorData);
+      }
+      if (request.status === 403) {
+        throw new PinataError(
+          "Unauthorized signing, you must be the original owner of the file and it must not have a signature",
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    return res.data;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error processing addSignature: ${error.message}`);
+    }
+    throw new PinataError("An unknown error occurred while adding signature to CID");
+  }
+};
+
+// src/core/signatures/getSignature.ts
+var getSignature = async (config, cid2) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  try {
+    const request = await fetch(`https://api.pinata.cloud/v3/ipfs/signature/${cid2}`, {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${config?.pinataJwt}`
+      }
+    });
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError("Authentication failed", request.status, errorData);
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    return res.data;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error processing getSignature: ${error.message}`);
+    }
+    throw new PinataError("An unknown error occurred while fetching signature for CID");
+  }
+};
+
+// src/core/signatures/removeSignature.ts
+var removeSignature = async (config, cid2) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  try {
+    const request = await fetch(`https://api.pinata.cloud/v3/ipfs/signature/${cid2}`, {
+      method: "DELETE",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${config?.pinataJwt}`
+      }
+    });
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError("Authentication failed", request.status, errorData);
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    return "OK";
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error processing addSignature: ${error.message}`);
+    }
+    throw new PinataError("An unknown error occurred while adding signature to CID");
+  }
+};
+
 // src/core/pinataSDK.ts
 var formatConfig = (config) => {
   let gateway = config?.pinataGateway;
@@ -1503,6 +1627,7 @@ var PinataSDK = class {
     this.usage = new Usage(this.config);
     this.keys = new Keys(this.config);
     this.groups = new Groups(this.config);
+    this.signatures = new Signatures(this.config);
   }
   testAuthentication() {
     return testAuthentication(this.config);
@@ -1565,10 +1690,7 @@ var UploadBuilder = class {
       options.peerAddresses = this.peerAddresses;
     }
     this.args[this.args.length - 1] = options;
-    return this.uploadFunction(this.config, ...this.args).then(
-      onfulfilled,
-      onrejected
-    );
+    return this.uploadFunction(this.config, ...this.args).then(onfulfilled, onrejected);
   }
 };
 var Upload = class {
@@ -1964,6 +2086,20 @@ var FilterGroups = class {
     return allItems;
   }
 };
+var Signatures = class {
+  constructor(config) {
+    this.config = formatConfig(config);
+  }
+  add(options) {
+    return addSignature(this.config, options);
+  }
+  get(cid2) {
+    return getSignature(this.config, cid2);
+  }
+  delete(cid2) {
+    return removeSignature(this.config, cid2);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PinataSDK