@opensea/seadn 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,15 @@
+# SeaDN Javascript SDK
+
+## Installation
+
+```sh
+npm i @opensea/seadn
+```
+
+## Usage
+
+```js
+import { resizeImage } from '@opensea/seadn';
+
+const resized = resizeImage(image, { height: 100, width: 100 });
+```

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export type ResizeParams = {
 };
 export declare const resizeImage: (image: string | URL, { width, height, dpr }: ResizeParams) => string;
 export declare const isSupportedFormat: (image: string | URL) => boolean;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,UACf,MAAM,GAAG,GAAG,0BACS,YAAY,KACvC,MAmBF,CAAC;AAEF,eAAO,MAAM,iBAAiB,UAAW,MAAM,GAAG,GAAG,YAcpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensea/seadn",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Javascript SDK to work with SeaDN",
   "license": "MIT",
   "author": "OpenSea Developers",
@@ -12,20 +12,24 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.module.js",
   "files": [
-    "dist"
+    "./dist",
+    "./src"
   ],
   "scripts": {
     "build": "microbundle",
     "check-types": "tsc --noEmit",
+    "lint": "concurrently \"npm run check-types\" \"npm run prettier:check\" \"npm run prettier:package.json:check\"",
     "prepare": "husky install",
     "prettier:check": "prettier --check .",
-    "prettier:check:package.json": "prettier-package-json --list-different",
     "prettier:fix": "prettier --write .",
+    "prettier:package.json:check": "prettier-package-json --list-different",
     "test": "vitest"
   },
   "sideEffects": false,
   "types": "./dist/index.d.ts",
   "devDependencies": {
+    "@vitest/coverage-c8": "^0.29.1",
+    "concurrently": "^7.6.0",
     "esbuild": "^0.17.10",
     "husky": "^8.0.3",
     "lint-staged": "^13.1.2",

package/src/index.test.ts

@@ -0,0 +1,40 @@
+import { expect, test } from 'vitest';
+import { resizeImage, isSupportedFormat } from '.';
+
+test.each([
+  [
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png',
+    { height: 100 },
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png?auto=format&dpr=1&h=100'
+  ],
+  [
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png',
+    { width: 100 },
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png?auto=format&dpr=1&w=100'
+  ],
+  [
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png',
+    { height: 100, width: 100 },
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png?auto=format&dpr=1&w=100&h=100'
+  ],
+  [
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png?auto=format&dpr=1&w=100&h=100',
+    { height: 200, width: 200 },
+    'https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png?auto=format&dpr=1&w=200&h=200'
+  ]
+])('resizeSeadnImage(%i, %i) -> %i', (url, resizeParams, expected) => {
+  expect(resizeImage(url, resizeParams)).toBe(expected);
+});
+
+test.each([
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.png', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.jpg', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.jpeg', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.webp', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.webp', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.gif', true],
+  ['https://i.seadn.io/gae/files/057bb30c6d80d54b78439927b2f07676', true],
+  ['https://i.seadn.io/gcs/files/057bb30c6d80d54b78439927b2f07676.mp3', false]
+])('isSupportedFormat(%i) -> %i', (url, expected) => {
+  expect(isSupportedFormat(url)).toBe(expected);
+});

package/src/index.ts

@@ -0,0 +1,45 @@
+export type ResizeParams = {
+  dpr?: number;
+  width?: number;
+  height?: number;
+};
+
+export const resizeImage = (
+  image: string | URL,
+  { width, height, dpr = 1 }: ResizeParams
+): string => {
+  if (typeof image === 'string') {
+    image = new URL(image);
+  }
+
+  const params = new URLSearchParams({
+    auto: 'format',
+    dpr: String(dpr)
+  });
+
+  if (width !== undefined) {
+    params.set('w', String(width));
+  }
+  if (height !== undefined) {
+    params.set('h', String(height));
+  }
+
+  image.search = params.toString();
+  return image.toString();
+};
+
+export const isSupportedFormat = (image: string | URL) => {
+  if (typeof image === 'string') {
+    image = new URL(image);
+  }
+
+  const { pathname } = image;
+  return (
+    pathname.endsWith('.jpg') ||
+    pathname.endsWith('.jpeg') ||
+    pathname.endsWith('.png') ||
+    pathname.endsWith('.webp') ||
+    pathname.endsWith('.gif') ||
+    pathname.startsWith('/gae/') // GoogleAppEngine URLs do not contain extensions
+  );
+};