@web3-storage/capabilities - npm Package Compare versions

Comparing version 17.3.0 to 17.4.0

dist/src/top.d.ts

@@ -7,3 +7,3 @@ /**
  */
-export const top: import("@ucanto/interface").TheCapabilityParser<import("@ucanto/interface").CapabilityMatch<"*", import("@ucanto/interface").URI<"did:">, any>>;
+export const top: import("@ucanto/interface").TheCapabilityParser<import("@ucanto/interface").CapabilityMatch<"*", import("@ucanto/interface").URI, any>>;
 //# sourceMappingURL=top.d.ts.map

dist/src/types.d.ts

@@ -96,2 +96,5 @@ import type { TupleToUnion } from 'type-fest';
 export type UsageReportFailure = Ucanto.Failure;
+export type EgressRecord = InferInvokedCapability<typeof UsageCaps.record>;
+export type EgressRecordSuccess = Unit;
+export type EgressRecordFailure = ConsumerNotFound | Ucanto.Failure;
 export interface UsageData {
@@ -126,2 +129,16 @@ /** Provider the report concerns, e.g. `did:web:web3.storage` */
 }
+export interface EgressData {
+    /** The space which contains the resource that was served. */
+    space: SpaceDID;
+    /** The customer that is being billed for the egress traffic. */
+    customer: AccountDID;
+    /** CID of the resource that was served it's the CID of some gateway accessible content. It is not the CID of a blob/shard.*/
+    resource: UnknownLink;
+    /** Amount of bytes served. */
+    bytes: number;
+    /** ISO datetime that the bytes were served at. */
+    servedAt: ISO8601Date;
+    /** Identifier of the invocation that caused the egress traffic. */
+    cause: UnknownLink;
+}
 export type ProviderAdd = InferInvokedCapability<typeof provider.add>;
@@ -153,2 +170,3 @@ export interface ProviderAddSuccess {
     subscription: string;
+    customer: AccountDID;
 }
@@ -155,0 +173,0 @@ export interface ConsumerNotFound extends Ucanto.Failure {

dist/src/usage.d.ts

@@ -25,3 +25,17 @@ /**
 }>>>;
+/**
+ * Capability can be invoked by an agent to record usage data for a given resource.
+ */
+export const record: import("@ucanto/interface").TheCapabilityParser<import("@ucanto/interface").CapabilityMatch<"usage/record", `did:key:${string}` & `did:${string}` & import("@ucanto/interface").Phantom<{
+    protocol: "did:";
+}>, Schema.InferStruct<{
+    resource: Schema.Schema<import("@ucanto/interface").Link<unknown, number, number, 0 | 1>, any>;
+    bytes: Schema.NumberSchema<number & import("@ucanto/interface").Phantom<{
+        typeof: "integer";
+    }>, unknown>;
+    servedAt: Schema.NumberSchema<number & import("@ucanto/interface").Phantom<{
+        typeof: "integer";
+    }>, unknown>;
+}>>>;
 import { Schema } from '@ucanto/validator';
 //# sourceMappingURL=usage.d.ts.map

package.json

 {
   "name": "@web3-storage/capabilities",
-  "version": "17.3.0",
+  "version": "17.4.0",
   "description": "UCAN Capabilities provided by web3.storage",
@@ -5,0 +5,0 @@ "homepage": "https://web3.storage",

src/top.js

@@ -12,3 +12,3 @@ /**
 
-import { capability, URI } from '@ucanto/validator'
+import { capability, Schema } from '@ucanto/validator'
 import { equalWith } from './utils.js'
@@ -24,4 +24,4 @@
   can: '*',
-  with: URI.match({ protocol: 'did:' }),
+  with: Schema.or(Schema.did(), Schema.literal('ucan:*')),
   derives: equalWith,
 })

src/types.ts

@@ -134,2 +134,6 @@ import type { TupleToUnion } from 'type-fest'
 
+export type EgressRecord = InferInvokedCapability<typeof UsageCaps.record>
+export type EgressRecordSuccess = Unit
+export type EgressRecordFailure = ConsumerNotFound | Ucanto.Failure
+
 export interface UsageData {
@@ -165,2 +169,17 @@ /** Provider the report concerns, e.g. `did:web:web3.storage` */
 
+export interface EgressData {
+  /** The space which contains the resource that was served. */
+  space: SpaceDID
+  /** The customer that is being billed for the egress traffic. */
+  customer: AccountDID
+  /** CID of the resource that was served it's the CID of some gateway accessible content. It is not the CID of a blob/shard.*/
+  resource: UnknownLink
+  /** Amount of bytes served. */
+  bytes: number
+  /** ISO datetime that the bytes were served at. */
+  servedAt: ISO8601Date
+  /** Identifier of the invocation that caused the egress traffic. */
+  cause: UnknownLink
+}
+
 // Provider
@@ -198,2 +217,3 @@ export type ProviderAdd = InferInvokedCapability<typeof provider.add>
   subscription: string
+  customer: AccountDID
 }
@@ -200,0 +220,0 @@ export interface ConsumerNotFound extends Ucanto.Failure {

src/usage.js

@@ -43,1 +43,18 @@ import { capability, ok, Schema } from '@ucanto/validator'
 })
+
+/**
+ * Capability can be invoked by an agent to record usage data for a given resource.
+ */
+export const record = capability({
+  can: 'usage/record',
+  with: SpaceDID,
+  nb: Schema.struct({
+    /** CID of the resource that was served. */
+    resource: Schema.link(),
+    /** Amount of bytes served. */
+    bytes: Schema.integer().greaterThan(0),
+    /** Timestamp of the event in seconds after Unix epoch. */
+    servedAt: Schema.integer().greaterThan(-1),
+  }),
+  derives: equalWith,
+})

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

199907

increased by1.67%

Number of downloads

28840

increased by89.66%

Lines of code

4695

increased by1.43%

Worsened metrics

Published versions last two months

3

decreased by-25%

Published versions last week

0

decreased by-100%

No dependency changes