@web3-storage/capabilities - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

dist/src/index.d.ts

@@ -1,6 +0,10 @@
-export * as Space from "./capabilities/space.js";
-export * as Top from "./capabilities/top.js";
-export * as Store from "./capabilities/store.js";
-export * as Upload from "./capabilities/upload.js";
-export * as Voucher from "./capabilities/voucher.js";
+/** @type {import('./types').AbilitiesArray} */
+export const abilitiesAsStrings: import('./types').AbilitiesArray;
+import * as Space from "./space.js";
+import * as Top from "./top.js";
+import * as Store from "./store.js";
+import * as Upload from "./upload.js";
+import * as Voucher from "./voucher.js";
+import * as Utils from "./utils.js";
+export { Space, Top, Store, Upload, Voucher, Utils };
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@web3-storage/capabilities",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Capabilities provided by web3.storage",
@@ -17,4 +17,4 @@ "homepage": "https://github.com/web3-storage/w3protocol/tree/main/packages/capabilities",
     ".": "./src/index.js",
-    "./types": "./dist/src/capabilities/types.d.ts",
-    "./*": "./src/capabilities/*.js"
+    "./types": "./dist/src/types.d.ts",
+    "./*": "./src/*.js"
   },
@@ -24,21 +24,21 @@ "typesVersions": {
       "space": [
-        "dist/src/capabilities/space"
+        "dist/src/space"
       ],
       "store": [
-        "dist/src/capabilities/store"
+        "dist/src/store"
       ],
       "types": [
-        "dist/src/capabilities/types"
+        "dist/src/types"
       ],
       "top": [
-        "dist/src/capabilities/top"
+        "dist/src/top"
       ],
       "upload": [
-        "dist/src/capabilities/upload"
+        "dist/src/upload"
       ],
       "utils": [
-        "dist/src/capabilities/utils"
+        "dist/src/utils"
       ],
       "voucher": [
-        "dist/src/capabilities/voucher"
+        "dist/src/voucher"
       ]
@@ -53,11 +53,7 @@ }
   "dependencies": {
-    "@ipld/car": "^5.0.1",
-    "@ipld/dag-ucan": "^2.0.1",
-    "@ucanto/client": "^3.0.2",
-    "@ucanto/core": "^3.0.2",
-    "@ucanto/interface": "^3.0.1",
-    "@ucanto/principal": "^3.0.1",
-    "@ucanto/server": "^3.0.4",
-    "@ucanto/transport": "^3.0.2",
-    "@ucanto/validator": "^3.0.4"
+    "@ucanto/core": "^4.0.2",
+    "@ucanto/interface": "^4.0.2",
+    "@ucanto/principal": "^4.0.2",
+    "@ucanto/transport": "^4.0.2",
+    "@ucanto/validator": "^4.0.2"
   },
@@ -67,4 +63,3 @@ "devDependencies": {
     "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.9",
-    "@web-std/fetch": "^4.1.0",
+    "@types/node": "^18.11.10",
     "assert": "^2.0.0",
@@ -74,2 +69,3 @@ "hd-scripts": "^3.0.2",
     "playwright-test": "^8.1.1",
+    "type-fest": "^3.3.0",
     "typescript": "4.8.4",
@@ -80,3 +76,3 @@ "watch": "^1.0.2"
     "extends": [
-      "./node_modules/hd-scripts/eslint/preact.js"
+      "./node_modules/hd-scripts/eslint/index.js"
     ],
@@ -99,11 +95,21 @@ "parserOptions": {
   },
+  "depcheck": {
+    "specials": [
+      "bin"
+    ],
+    "ignores": [
+      "@types/*",
+      "hd-scripts",
+      "assert"
+    ]
+  },
   "scripts": {
     "lint": "tsc && eslint '**/*.{js,ts}' && prettier --check '**/*.{js,ts,yml,json}' --ignore-path ../../.gitignore",
     "build": "tsc --build",
-    "test": "pnpm -r --filter @web3-storage/capabilities run build && npm run test:node && npm run test:browser",
-    "test:node": "mocha 'test/**/!(*.browser).test.js' -n experimental-vm-modules -n no-warnings",
-    "test:browser": "playwright-test 'test/**/!(*.node).test.js'",
-    "testw": "watch 'pnpm test' src test --interval 1",
+    "test": "pnpm run test:node && pnpm run test:browser",
+    "test:node": "mocha 'test/**/*.test.js' -n experimental-vm-modules -n no-warnings",
+    "test:browser": "playwright-test",
+    "testw": "watch 'pnpm test:node' src test --interval 1",
     "rc": "npm version prerelease --preid rc"
   }
 }

readme.md

@@ -5,12 +5,2 @@ # ⁂ `@web3-storage/capabilities`
 
-## Exports
-
-* '@web3-storage/capabilities/space`
-* '@web3-storage/capabilities/store`
-* '@web3-storage/capabilities/top`
-* '@web3-storage/capabilities/types`
-* '@web3-storage/capabilities/upload`
-* '@web3-storage/capabilities/utils`
-* '@web3-storage/capabilities/voucher`
-
 ## Install
@@ -27,1 +17,13 @@
 [API Reference](https://web3-storage.github.io/w3protocol/modules/_web3_storage_capabilities.html)
+
+```js
+import * as Space from '@web3-storage/capabilities/space'
+import * as Store from '@web3-storage/capabilities/store'
+import * as Top from '@web3-storage/capabilities/top'
+import * as Types from '@web3-storage/capabilities/types'
+import * as Upload from '@web3-storage/capabilities/upload'
+import * as Utils from '@web3-storage/capabilities/utils'
+import * as Voucher from '@web3-storage/capabilities/voucher'
+
+// This package has a "main" entrypoint but we recommend the usage of the specific imports above
+```

src/index.js

@@ -1,5 +0,27 @@
-export * as Space from './capabilities/space.js'
-export * as Top from './capabilities/top.js'
-export * as Store from './capabilities/store.js'
-export * as Upload from './capabilities/upload.js'
-export * as Voucher from './capabilities/voucher.js'
+import * as Space from './space.js'
+import * as Top from './top.js'
+import * as Store from './store.js'
+import * as Upload from './upload.js'
+import * as Voucher from './voucher.js'
+import * as Utils from './utils.js'
+
+export { Space, Top, Store, Upload, Voucher, Utils }
+
+/** @type {import('./types').AbilitiesArray} */
+export const abilitiesAsStrings = [
+  Top.top.can,
+  Space.space.can,
+  Space.info.can,
+  Space.recover.can,
+  Space.recoverValidation.can,
+  Upload.upload.can,
+  Upload.add.can,
+  Upload.remove.can,
+  Upload.list.can,
+  Store.store.can,
+  Store.add.can,
+  Store.remove.can,
+  Store.list.can,
+  Voucher.claim.can,
+  Voucher.redeem.can,
+]

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

58718

increased by9.8%

Dependency count

5

decreased by-44.44%

Lines of code

1309

increased by10.46%

Number of lines in readme file

28

increased by7.69%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@ipld/dag-json@10.2.3(transitive)

• + Added@ipld/dag-ucan@3.4.0(transitive)

• + Added@ucanto/core@4.4.0(transitive)

• + Added@ucanto/interface@4.4.1(transitive)

• + Added@ucanto/principal@4.4.0(transitive)

• + Added@ucanto/transport@4.4.0(transitive)

• + Added@ucanto/validator@4.4.0(transitive)

• - Removed@ipld/car@^5.0.1

• - Removed@ipld/dag-ucan@^2.0.1

• - Removed@ucanto/client@^3.0.2

• - Removed@ucanto/server@^3.0.4

• - Removed@ipld/dag-json@9.1.1(transitive)

• - Removed@ipld/dag-ucan@2.0.1(transitive)

• - Removed@ucanto/client@3.0.5(transitive)

• - Removed@ucanto/core@3.0.5(transitive)

• - Removed@ucanto/interface@3.0.1(transitive)

• - Removed@ucanto/principal@3.0.1(transitive)

• - Removed@ucanto/server@3.0.8(transitive)

• - Removed@ucanto/transport@3.0.5(transitive)

• - Removed@ucanto/validator@3.0.7(transitive)

• - Removedmultiformats@10.0.3(transitive)

• Updated@ucanto/core@^4.0.2

• Updated@ucanto/interface@^4.0.2

• Updated@ucanto/principal@^4.0.2

• Updated@ucanto/transport@^4.0.2

• Updated@ucanto/validator@^4.0.2