@web3-storage/capabilities - npm Package Compare versions

Comparing version 14.0.2 to 15.0.0

dist/src/index.d.ts

@@ -1,3 +0,3 @@
-/** @type {import('./types.js').AbilitiesArray} */
-export const abilitiesAsStrings: import('./types.js').AbilitiesArray;
+/** @type {import('./types.js').ServiceAbility[]} */
+export const abilitiesAsStrings: import('./types.js').ServiceAbility[];
 import * as Access from './access.js';
@@ -16,2 +16,3 @@ import * as Provider from './provider.js';
 import * as Filecoin from './filecoin/index.js';
+import * as Index from './index/index.js';
 import * as Storefront from './filecoin/storefront.js';
@@ -28,3 +29,3 @@ import * as Aggregator from './filecoin/aggregator.js';
 import * as HTTP from './http.js';
-export { Access, Provider, Space, Top, Store, Upload, Consumer, Customer, Console, Utils, RateLimit, Subscription, Filecoin, Storefront, Aggregator, Dealer, DealTracker, Admin, UCAN, Plan, Usage, Blob, W3sBlob, HTTP };
+export { Access, Provider, Space, Top, Store, Upload, Consumer, Customer, Console, Utils, RateLimit, Subscription, Filecoin, Index, Storefront, Aggregator, Dealer, DealTracker, Admin, UCAN, Plan, Usage, Blob, W3sBlob, HTTP };
 //# sourceMappingURL=index.d.ts.map

dist/src/types.d.ts

@@ -24,2 +24,3 @@ import type { TupleToUnion } from 'type-fest';
 import * as DealerCaps from './filecoin/dealer.js';
+import * as IndexCaps from './index/index.js';
 import * as AdminCaps from './admin.js';
@@ -38,2 +39,3 @@ import * as UCANCaps from './ucan.js';
 export type CARLink = Link<unknown, typeof CAR.codec.code>;
+export type Multihash = Uint8Array;
 export type AccountDID = DID<'mailto'>;
@@ -347,2 +349,22 @@ export type SpaceDID = DID<'key'>;
 export type HTTPPut = InferInvokedCapability<typeof HTTPCaps.put>;
+export type Index = InferInvokedCapability<typeof IndexCaps.index>;
+export type IndexAdd = InferInvokedCapability<typeof IndexCaps.add>;
+export type IndexAddSuccess = Unit;
+export type IndexAddFailure = UnknownFormat | ShardNotFound | SliceNotFound | Failure;
+/** The index is not in a format understood by the service. */
+export interface UnknownFormat extends Failure {
+    name: 'UnknownFormat';
+}
+/** A shard referenced by the index is not stored in the referenced space. */
+export interface ShardNotFound extends Failure {
+    name: 'ShardNotFound';
+    /** Multihash digest of the shard that could not be found. */
+    digest: Multihash;
+}
+/** A slice referenced by the index was not found in the specified shard. */
+export interface SliceNotFound extends Failure {
+    name: 'SliceNotFound';
+    /** Multihash digest of the slice that could not be found. */
+    digest: Multihash;
+}
 export type Blob = InferInvokedCapability<typeof BlobCaps.blob>;
@@ -355,5 +377,4 @@ export type BlobAdd = InferInvokedCapability<typeof BlobCaps.add>;
 export type BlobAccept = InferInvokedCapability<typeof W3sBlobCaps.accept>;
-export type BlobMultihash = Uint8Array;
 export interface BlobModel {
-    digest: BlobMultihash;
+    digest: Multihash;
     size: number;
@@ -624,3 +645,5 @@ }
     BlobAccept['can'],
-    HTTPPut['can']
+    HTTPPut['can'],
+    Index['can'],
+    IndexAdd['can']
 ];
@@ -627,0 +650,0 @@ /**

package.json

 {
   "name": "@web3-storage/capabilities",
-  "version": "14.0.2",
+  "version": "15.0.0",
   "description": "UCAN Capabilities provided by web3.storage",
@@ -48,2 +48,6 @@ "homepage": "https://web3.storage",
     },
+    "./index": {
+      "types": "./dist/src/index/index.d.ts",
+      "import": "./src/index/index.js"
+    },
     "./web3.storage/blob": {
@@ -50,0 +54,0 @@ "types": "./dist/src/web3.storage/blob.d.ts",

readme.md

@@ -36,2 +36,3 @@ # ⁂ `@web3-storage/capabilities`
 import * as Dealer from '@web3-storage/capabilities/filecoin/dealer'
+import * as Index from '@web3-storage/capabilities/index'
 
@@ -38,0 +39,0 @@ // This package has a "main" entrypoint but we recommend the usage of the specific imports above

src/index.js

@@ -19,2 +19,3 @@ import * as Provider from './provider.js'
 import * as DealTracker from './filecoin/deal-tracker.js'
+import * as Index from './index/index.js'
 import * as UCAN from './ucan.js'
@@ -41,2 +42,3 @@ import * as Plan from './plan.js'
   Filecoin,
+  Index,
   Storefront,
@@ -55,3 +57,3 @@ Aggregator,
 
-/** @type {import('./types.js').AbilitiesArray} */
+/** @type {import('./types.js').ServiceAbility[]} */
 export const abilitiesAsStrings = [
@@ -107,2 +109,4 @@ Top.top.can,
   HTTP.put.can,
+  Index.index.can,
+  Index.add.can,
 ]

src/types.ts

@@ -38,2 +38,3 @@ import type { TupleToUnion } from 'type-fest'
 import * as DealerCaps from './filecoin/dealer.js'
+import * as IndexCaps from './index/index.js'
 import * as AdminCaps from './admin.js'
@@ -57,2 +58,4 @@ import * as UCANCaps from './ucan.js'
 
+export type Multihash = Uint8Array
+
 export type AccountDID = DID<'mailto'>
@@ -454,2 +457,33 @@ export type SpaceDID = DID<'key'>
 
+// Index
+export type Index = InferInvokedCapability<typeof IndexCaps.index>
+export type IndexAdd = InferInvokedCapability<typeof IndexCaps.add>
+
+export type IndexAddSuccess = Unit
+
+export type IndexAddFailure =
+  | UnknownFormat
+  | ShardNotFound
+  | SliceNotFound
+  | Failure
+
+/** The index is not in a format understood by the service. */
+export interface UnknownFormat extends Failure {
+  name: 'UnknownFormat'
+}
+
+/** A shard referenced by the index is not stored in the referenced space. */
+export interface ShardNotFound extends Failure {
+  name: 'ShardNotFound'
+  /** Multihash digest of the shard that could not be found. */
+  digest: Multihash
+}
+
+/** A slice referenced by the index was not found in the specified shard. */
+export interface SliceNotFound extends Failure {
+  name: 'SliceNotFound'
+  /** Multihash digest of the slice that could not be found. */
+  digest: Multihash
+}
+
 // Blob
@@ -464,5 +498,4 @@ export type Blob = InferInvokedCapability<typeof BlobCaps.blob>
 
-export type BlobMultihash = Uint8Array
 export interface BlobModel {
-  digest: BlobMultihash
+  digest: Multihash
   size: number
@@ -848,3 +881,5 @@ }
   BlobAccept['can'],
-  HTTPPut['can']
+  HTTPPut['can'],
+  Index['can'],
+  IndexAdd['can']
 ]
@@ -851,0 +886,0 @@

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

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

190269

increased by3.17%

Number of package files

87

increased by3.57%

Lines of code

4481

increased by2.87%

Number of lines in readme file

165

increased by0.61%

No dependency changes