@orangecheck/me-client 0.14.0 → 0.15.0

package/dist/index.d.mts

@@ -23,6 +23,26 @@ declare const scope: {
     request: typeof request;
 };
 
+type FamilyVerb = 'oc-vote' | 'oc-stamp' | 'oc-agent' | 'oc-attest' | 'oc-lock';
+interface FamilyScopesOptions {
+    origin?: string;
+    signal?: AbortSignal;
+}
+interface FamilyScopesResult {
+    sub: string;
+    family_product: {
+        verb: FamilyVerb;
+        name: string;
+        origin: string;
+    };
+    scopes_granted: Scope[];
+    scopes: Partial<Record<Scope, string>>;
+}
+declare function scopes(verb: FamilyVerb, options?: FamilyScopesOptions): Promise<FamilyScopesResult>;
+declare const family: {
+    scopes: typeof scopes;
+};
+
 interface VerifyResult {
     ok: boolean;
     reason?: string;
@@ -323,6 +343,9 @@ declare const oc: {
         granted: (options: GrantedOptions) => Promise<GrantedResult>;
         request: typeof request;
     };
+    family: {
+        scopes: (verb: FamilyVerb, options?: FamilyScopesOptions) => Promise<FamilyScopesResult>;
+    };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };
+export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type FamilyScopesOptions, type FamilyScopesResult, type FamilyVerb, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, family, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };

package/dist/index.d.ts

@@ -23,6 +23,26 @@ declare const scope: {
     request: typeof request;
 };
 
+type FamilyVerb = 'oc-vote' | 'oc-stamp' | 'oc-agent' | 'oc-attest' | 'oc-lock';
+interface FamilyScopesOptions {
+    origin?: string;
+    signal?: AbortSignal;
+}
+interface FamilyScopesResult {
+    sub: string;
+    family_product: {
+        verb: FamilyVerb;
+        name: string;
+        origin: string;
+    };
+    scopes_granted: Scope[];
+    scopes: Partial<Record<Scope, string>>;
+}
+declare function scopes(verb: FamilyVerb, options?: FamilyScopesOptions): Promise<FamilyScopesResult>;
+declare const family: {
+    scopes: typeof scopes;
+};
+
 interface VerifyResult {
     ok: boolean;
     reason?: string;
@@ -323,6 +343,9 @@ declare const oc: {
         granted: (options: GrantedOptions) => Promise<GrantedResult>;
         request: typeof request;
     };
+    family: {
+        scopes: (verb: FamilyVerb, options?: FamilyScopesOptions) => Promise<FamilyScopesResult>;
+    };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };
+export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type FamilyScopesOptions, type FamilyScopesResult, type FamilyVerb, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, family, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };

package/dist/index.js

@@ -831,17 +831,17 @@ async function granted(options) {
     scopes: r.scopes
   };
 }
-function request(scopes, options) {
+function request(scopes2, options) {
   if (!options.project_key) {
     throw new Error("oc.scope.request: project_key is required");
   }
   if (!options.return_to) {
     throw new Error("oc.scope.request: return_to is required");
   }
-  if (!Array.isArray(scopes) || scopes.length === 0) {
+  if (!Array.isArray(scopes2) || scopes2.length === 0) {
     throw new Error("oc.scope.request: scopes must be a non-empty array");
   }
-  for (const s of scopes) {
+  for (const s of scopes2) {
     if (!VALID_SCOPES.includes(s)) {
       throw new Error(
         `oc.scope.request: unknown scope "${s}" \xB7 valid: ${VALID_SCOPES.join(", ")}`
@@ -854,15 +854,50 @@ function request(scopes, options) {
   const origin2 = options.origin ?? getOrigin();
   const url = new URL("/me/scope-grant", origin2);
   url.searchParams.set("project_key", options.project_key);
-  url.searchParams.set("scopes", scopes.join(","));
+  url.searchParams.set("scopes", scopes2.join(","));
   url.searchParams.set("return_to", options.return_to);
   window.location.assign(url.toString());
   throw new Error("oc.scope.request: redirected to consent prompt");
 }
 var scope = { granted, request };
 
+// src/family.ts
+var VALID_VERBS = [
+  "oc-vote",
+  "oc-stamp",
+  "oc-agent",
+  "oc-attest",
+  "oc-lock"
+];
+async function scopes(verb, options) {
+  if (!VALID_VERBS.includes(verb)) {
+    throw new Error(
+      `oc.family.scopes: unknown verb "${verb}" \xB7 valid: ${VALID_VERBS.join(", ")}`
+    );
+  }
+  const origin2 = options?.origin ?? "https://me.ochk.io";
+  const url = `${origin2}/api/family/scopes/${encodeURIComponent(verb)}`;
+  const res = await fetch(url, {
+    method: "GET",
+    credentials: "include",
+    signal: options?.signal
+  });
+  if (!res.ok) {
+    const txt = await res.text().catch(() => "");
+    throw new Error(`oc.family.scopes: ${res.status} ${txt || res.statusText}`);
+  }
+  const json = await res.json();
+  return {
+    sub: json.sub,
+    family_product: json.family_product,
+    scopes_granted: json.scopes_granted,
+    scopes: json.scopes
+  };
+}
+var family = { scopes };
+
 // src/index.ts
-var oc = { session, payment, event, config, webhook, federations, scope };
+var oc = { session, payment, event, config, webhook, federations, scope, family };
 
 exports.MIN_INTEGRATOR_PRICE_SATS = MIN_INTEGRATOR_PRICE_SATS;
 exports.MeClientError = MeClientError;
@@ -872,6 +907,7 @@ exports.clearBearerToken = clearBearerToken;
 exports.computeFees = computeFees;
 exports.config = config;
 exports.event = event;
+exports.family = family;
 exports.federations = federations;
 exports.getBearerToken = getBearerToken;
 exports.getOrigin = getOrigin;