@opendatalabs/vana-sdk 3.15.0 → 3.16.0

package/dist/index.node.cjs

@@ -1201,6 +1201,7 @@ __export(index_node_exports, {
   InMemoryTokenStore: () => InMemoryTokenStore,
   IngestResponseSchema: () => IngestResponseSchema,
   InvalidConfigurationError: () => InvalidConfigurationError,
+  InvalidScopeEntryError: () => InvalidScopeEntryError,
   InvalidSignatureError: () => InvalidSignatureError,
   IpfsStorage: () => IpfsStorage,
   MASTER_KEY_MESSAGE: () => MASTER_KEY_MESSAGE,
@@ -1228,6 +1229,7 @@ __export(index_node_exports, {
   REGISTRATION_KIND_FOR_OP: () => REGISTRATION_KIND_FOR_OP,
   ReadOnlyError: () => ReadOnlyError,
   RelayerError: () => RelayerError,
+  SCOPE_ACTIONS: () => SCOPE_ACTIONS,
   SERVER_REGISTRATION_TYPES: () => SERVER_REGISTRATION_TYPES,
   ScopeSchema: () => ScopeSchema,
   SerializationError: () => SerializationError,
@@ -1285,6 +1287,7 @@ __export(index_node_exports, {
   encryptWithPassword: () => encryptWithPassword,
   escrowContractAddress: () => escrowContractAddress,
   escrowPaymentDomain: () => escrowPaymentDomain,
+  formatScopeEntry: () => formatScopeEntry,
   generatePkceVerifier: () => generatePkceVerifier,
   genericPaymentDomain: () => genericPaymentDomain,
   getAbi: () => getAbi,
@@ -1297,8 +1300,10 @@ __export(index_node_exports, {
   getOpFee: () => getOpFee,
   getPlatformCapabilities: () => getPlatformCapabilities,
   getServiceEndpoints: () => getServiceEndpoints,
+  grantPermissions: () => grantPermissions,
   grantRegistrationDomain: () => grantRegistrationDomain,
   grantRevocationDomain: () => grantRevocationDomain,
+  hasAction: () => hasAction,
   isDataPortabilityGatewayConfig: () => isDataPortabilityGatewayConfig,
   isECIESEncrypted: () => isECIESEncrypted,
   isPlatformSupported: () => isPlatformSupported,
@@ -1309,9 +1314,11 @@ __export(index_node_exports, {
   parsePSError: () => parsePSError,
   parsePersonalServerPaymentRequired: () => parsePersonalServerPaymentRequired,
   parseScope: () => parseScope,
+  parseScopeEntry: () => parseScopeEntry,
   parseWeb3SignedHeader: () => parseWeb3SignedHeader,
   paymentReceiptFromHeader: () => paymentReceiptFromHeader,
   paymentResponseMetadataFromHeader: () => paymentResponseMetadataFromHeader,
+  permissionsToScopes: () => permissionsToScopes,
   personalServerDataReadPath: () => personalServerDataReadPath,
   personalServerRegistrationDomain: () => personalServerRegistrationDomain,
   readPersonalServerData: () => readPersonalServerData,
@@ -1327,6 +1334,7 @@ __export(index_node_exports, {
   signPersonalServerRegistrationWithAccount: () => signPersonalServerRegistrationWithAccount,
   toDirectFeeBreakdown: () => toDirectFeeBreakdown,
   toDirectPaymentReceipt: () => toDirectPaymentReceipt,
+  tryGrantPermissions: () => tryGrantPermissions,
   vanaMainnet: () => vanaMainnet2,
   verifyGrantRegistration: () => verifyGrantRegistration,
   verifyPkceChallenge: () => verifyPkceChallenge,
@@ -33745,7 +33753,161 @@ function scopeCoveredByGrant(requestedScope, grantedScopes) {
   );
 }
 
+// src/protocol/scope-actions.ts
+var SCOPE_ACTIONS = ["read", "write"];
+var InvalidScopeEntryError = class extends Error {
+  /** The offending entry, verbatim (unknown because it may not be a string). */
+  entry;
+  constructor(entry, reason) {
+    super(`Invalid scope entry ${describeValue(entry)}: ${reason}`);
+    this.name = "InvalidScopeEntryError";
+    this.entry = entry;
+  }
+};
+var OPERATION_SEPARATOR = ":";
+function describeValue(value) {
+  if (typeof value === "string") return JSON.stringify(value);
+  if (value === null) return "null";
+  return `[${typeof value}]`;
+}
+var OPERATION_BY_PREFIX = {
+  write: "write"
+};
+function assertScopePart(entry, scope) {
+  if (scope.length === 0) {
+    throw new InvalidScopeEntryError(entry, "scope part is empty");
+  }
+  if (scope.includes(OPERATION_SEPARATOR)) {
+    throw new InvalidScopeEntryError(
+      entry,
+      `scope part must not contain "${OPERATION_SEPARATOR}"`
+    );
+  }
+}
+function parseScopeEntry(entry) {
+  const raw = entry;
+  if (typeof raw !== "string") {
+    throw new InvalidScopeEntryError(raw, "entry must be a string");
+  }
+  const separatorIndex = entry.indexOf(OPERATION_SEPARATOR);
+  if (separatorIndex === -1) {
+    assertScopePart(entry, entry);
+    return { scope: entry, action: "read" };
+  }
+  const prefix = entry.slice(0, separatorIndex);
+  const scope = entry.slice(separatorIndex + 1);
+  const action = Object.hasOwn(OPERATION_BY_PREFIX, prefix) ? OPERATION_BY_PREFIX[prefix] : void 0;
+  if (action === void 0) {
+    throw new InvalidScopeEntryError(
+      entry,
+      `unknown operation "${prefix}" (known: ${Object.keys(OPERATION_BY_PREFIX).join(", ")}; read has no prefix)`
+    );
+  }
+  assertScopePart(entry, scope);
+  return { scope, action };
+}
+function formatScopeEntry(parsed) {
+  const { scope, action } = parsed;
+  assertScopePart(scope, scope);
+  if (action === "read") return scope;
+  const prefix = Object.entries(OPERATION_BY_PREFIX).find(
+    ([, candidate]) => candidate === action
+  )?.[0];
+  if (prefix === void 0) {
+    throw new InvalidScopeEntryError(
+      scope,
+      `unknown action ${describeValue(action)} (known: ${SCOPE_ACTIONS.join(", ")})`
+    );
+  }
+  return `${prefix}${OPERATION_SEPARATOR}${scope}`;
+}
+function compareScopes(a, b) {
+  if (a < b) return -1;
+  if (a > b) return 1;
+  return 0;
+}
+function sortActions(actions) {
+  const present = new Set(actions);
+  return SCOPE_ACTIONS.filter((action) => present.has(action));
+}
+function grantPermissions(scopes) {
+  const byScope = /* @__PURE__ */ new Map();
+  for (const entry of scopes) {
+    const { scope, action } = parseScopeEntry(entry);
+    let actions = byScope.get(scope);
+    if (actions === void 0) {
+      actions = /* @__PURE__ */ new Set();
+      byScope.set(scope, actions);
+    }
+    actions.add(action);
+  }
+  return [...byScope.keys()].sort(compareScopes).map((scope) => ({
+    scope,
+    actions: sortActions(byScope.get(scope) ?? [])
+  }));
+}
+function permissionsToScopes(permissions) {
+  const byScope = /* @__PURE__ */ new Map();
+  for (const { scope, actions } of permissions) {
+    let merged = byScope.get(scope);
+    if (merged === void 0) {
+      merged = /* @__PURE__ */ new Set();
+      byScope.set(scope, merged);
+    }
+    for (const action of actions) {
+      if (!SCOPE_ACTIONS.includes(action)) {
+        throw new InvalidScopeEntryError(
+          scope,
+          `unknown action ${describeValue(action)} (known: ${SCOPE_ACTIONS.join(", ")})`
+        );
+      }
+      merged.add(action);
+    }
+  }
+  const entries = [];
+  for (const scope of [...byScope.keys()].sort(compareScopes)) {
+    for (const action of sortActions(byScope.get(scope) ?? [])) {
+      entries.push(formatScopeEntry({ scope, action }));
+    }
+  }
+  return entries;
+}
+function hasAction(scopes, scope, action) {
+  if (scope.includes(OPERATION_SEPARATOR)) return false;
+  for (const entry of scopes) {
+    let parsed;
+    try {
+      parsed = parseScopeEntry(entry);
+    } catch (error) {
+      if (error instanceof InvalidScopeEntryError) continue;
+      throw error;
+    }
+    if (parsed.action === action && scopeMatchesPattern(scope, parsed.scope)) {
+      return true;
+    }
+  }
+  return false;
+}
+function tryGrantPermissions(scopes) {
+  try {
+    return grantPermissions(scopes);
+  } catch (error) {
+    if (error instanceof InvalidScopeEntryError) return void 0;
+    throw error;
+  }
+}
+
 // src/protocol/gateway.ts
+function withGrantPermissions(grant) {
+  const stripped = { ...grant };
+  delete stripped.permissions;
+  const scopes = stripped.scopes;
+  if (!Array.isArray(scopes)) {
+    return stripped;
+  }
+  const permissions = tryGrantPermissions(scopes);
+  return permissions === void 0 ? stripped : { ...stripped, permissions };
+}
 function createGatewayClient(baseUrl) {
   const base = baseUrl.replace(/\/+$/, "");
   async function unwrapEnvelope(res) {
@@ -33775,7 +33937,9 @@ function createGatewayClient(baseUrl) {
       if (!res.ok) {
         throw new Error(`Gateway error: ${res.status} ${res.statusText}`);
       }
-      return unwrapEnvelope(res);
+      return withGrantPermissions(
+        await unwrapEnvelope(res)
+      );
     },
     async listGrantsByUser(userAddress) {
       const res = await fetch(`${base}/v1/grants?user=${userAddress}`);
@@ -33783,7 +33947,8 @@ function createGatewayClient(baseUrl) {
       if (!res.ok) {
         throw new Error(`Gateway error: ${res.status} ${res.statusText}`);
       }
-      return unwrapEnvelope(res);
+      const grants = await unwrapEnvelope(res);
+      return grants.map(withGrantPermissions);
     },
     async getSchemaForScope(scope) {
       const res = await fetch(`${base}/v1/schemas?scope=${scope}`);
@@ -34719,6 +34884,7 @@ async function parsePSError(response) {
   InMemoryTokenStore,
   IngestResponseSchema,
   InvalidConfigurationError,
+  InvalidScopeEntryError,
   InvalidSignatureError,
   IpfsStorage,
   MASTER_KEY_MESSAGE,
@@ -34746,6 +34912,7 @@ async function parsePSError(response) {
   REGISTRATION_KIND_FOR_OP,
   ReadOnlyError,
   RelayerError,
+  SCOPE_ACTIONS,
   SERVER_REGISTRATION_TYPES,
   ScopeSchema,
   SerializationError,
@@ -34803,6 +34970,7 @@ async function parsePSError(response) {
   encryptWithPassword,
   escrowContractAddress,
   escrowPaymentDomain,
+  formatScopeEntry,
   generatePkceVerifier,
   genericPaymentDomain,
   getAbi,
@@ -34815,8 +34983,10 @@ async function parsePSError(response) {
   getOpFee,
   getPlatformCapabilities,
   getServiceEndpoints,
+  grantPermissions,
   grantRegistrationDomain,
   grantRevocationDomain,
+  hasAction,
   isDataPortabilityGatewayConfig,
   isECIESEncrypted,
   isPlatformSupported,
@@ -34827,9 +34997,11 @@ async function parsePSError(response) {
   parsePSError,
   parsePersonalServerPaymentRequired,
   parseScope,
+  parseScopeEntry,
   parseWeb3SignedHeader,
   paymentReceiptFromHeader,
   paymentResponseMetadataFromHeader,
+  permissionsToScopes,
   personalServerDataReadPath,
   personalServerRegistrationDomain,
   readPersonalServerData,
@@ -34845,6 +35017,7 @@ async function parsePSError(response) {
   signPersonalServerRegistrationWithAccount,
   toDirectFeeBreakdown,
   toDirectPaymentReceipt,
+  tryGrantPermissions,
   vanaMainnet,
   verifyGrantRegistration,
   verifyPkceChallenge,