From d6aa1603efcb6318525e9dc0bad0c80d645662e0 Mon Sep 17 00:00:00 2001 From: ochk-docs-bot Date: Sun, 10 May 2026 04:24:47 +0000 Subject: [PATCH] docs(sdk): sync me-client@0.18.0 Auto-generated by oc-packages release workflow on tag me-client-v0.18.0. Source: https://github.com/orangecheck/oc-packages/tree/me-client-v0.18.0/me-client/src Co-Authored-By: ochk-docs-bot --- src/pages/sdk/me-client/README.mdx | 19 ++ .../sdk/me-client/classes/MeClientError.mdx | 121 ++----- .../me-client/functions/OcSignInButton.mdx | 4 +- .../sdk/me-client/functions/computeFees.mdx | 2 +- .../functions/configFromTemplate.mdx | 38 +++ .../functions/getArchetypeTemplate.mdx | 31 ++ .../functions/parseTrustAttestationCount.mdx | 36 +++ .../me-client/functions/subtypesForClass.mdx | 30 ++ .../functions/validateIntegratorConfig.mdx | 2 +- .../functions/withRateLimitRetry.mdx | 58 ++++ .../interfaces/ArchetypeTemplate.mdx | 28 ++ .../me-client/interfaces/BillableEvent.mdx | 35 +- .../sdk/me-client/interfaces/ComputedFees.mdx | 10 +- .../interfaces/EventSubtypeMetadata.mdx | 26 ++ .../interfaces/FamilyScopesOptions.mdx | 21 ++ .../interfaces/FamilyScopesResult.mdx | 26 ++ .../sdk/me-client/interfaces/Federation.mdx | 32 +- .../me-client/interfaces/FireEventOptions.mdx | 1 + .../me-client/interfaces/GrantedOptions.mdx | 6 +- .../me-client/interfaces/GrantedResult.mdx | 8 +- .../interfaces/IntegratorEventConfig.mdx | 8 +- .../interfaces/IntegratorPriceConfig.mdx | 12 +- .../interfaces/OcSignInButtonProps.mdx | 304 ++---------------- .../interfaces/PaymentAuthorizeOptions.mdx | 12 +- .../me-client/interfaces/PaymentResult.mdx | 12 +- .../me-client/interfaces/RequestOptions.mdx | 8 +- .../sdk/me-client/interfaces/Session.mdx | 14 +- .../me-client/interfaces/SessionPolicy.mdx | 8 +- .../me-client/interfaces/SignInOptions.mdx | 8 +- .../me-client/interfaces/TelemetryEvent.mdx | 8 +- .../interfaces/TrustAttestationCount.mdx | 29 ++ .../me-client/interfaces/ValidationResult.mdx | 6 +- .../interfaces/VerifyEventResult.mdx | 8 +- .../me-client/interfaces/WebhookHeaders.mdx | 28 ++ .../me-client/interfaces/WebhookPayload.mdx | 60 ++++ .../interfaces/WithRateLimitRetryOptions.mdx | 22 ++ .../sdk/me-client/type-aliases/AttestTier.mdx | 15 +- .../me-client/type-aliases/ClassASubtype.mdx | 2 +- .../sdk/me-client/type-aliases/FamilyVerb.mdx | 18 ++ .../type-aliases/FederationStatus.mdx | 2 +- .../type-aliases/IntegratorArchetype.mdx | 23 ++ .../sdk/me-client/type-aliases/Scope.mdx | 21 +- .../me-client/type-aliases/SigningMethod.mdx | 2 +- .../me-client/type-aliases/SiteFeeShape.mdx | 2 +- .../variables/ALL_EVENT_SUBTYPES.mdx | 20 ++ .../variables/ARCHETYPE_TEMPLATES.mdx | 23 ++ .../me-client/variables/EVENT_SUBTYPES.mdx | 18 ++ src/pages/sdk/me-client/variables/config.mdx | 14 +- src/pages/sdk/me-client/variables/event.mdx | 8 +- src/pages/sdk/me-client/variables/family.mdx | 26 ++ src/pages/sdk/me-client/variables/oc.mdx | 70 ++-- src/pages/sdk/me-client/variables/scope.mdx | 10 +- 52 files changed, 831 insertions(+), 524 deletions(-) create mode 100644 src/pages/sdk/me-client/functions/configFromTemplate.mdx create mode 100644 src/pages/sdk/me-client/functions/getArchetypeTemplate.mdx create mode 100644 src/pages/sdk/me-client/functions/parseTrustAttestationCount.mdx create mode 100644 src/pages/sdk/me-client/functions/subtypesForClass.mdx create mode 100644 src/pages/sdk/me-client/functions/withRateLimitRetry.mdx create mode 100644 src/pages/sdk/me-client/interfaces/ArchetypeTemplate.mdx create mode 100644 src/pages/sdk/me-client/interfaces/EventSubtypeMetadata.mdx create mode 100644 src/pages/sdk/me-client/interfaces/FamilyScopesOptions.mdx create mode 100644 src/pages/sdk/me-client/interfaces/FamilyScopesResult.mdx create mode 100644 src/pages/sdk/me-client/interfaces/TrustAttestationCount.mdx create mode 100644 src/pages/sdk/me-client/interfaces/WebhookHeaders.mdx create mode 100644 src/pages/sdk/me-client/interfaces/WebhookPayload.mdx create mode 100644 src/pages/sdk/me-client/interfaces/WithRateLimitRetryOptions.mdx create mode 100644 src/pages/sdk/me-client/type-aliases/FamilyVerb.mdx create mode 100644 src/pages/sdk/me-client/type-aliases/IntegratorArchetype.mdx create mode 100644 src/pages/sdk/me-client/variables/ALL_EVENT_SUBTYPES.mdx create mode 100644 src/pages/sdk/me-client/variables/ARCHETYPE_TEMPLATES.mdx create mode 100644 src/pages/sdk/me-client/variables/EVENT_SUBTYPES.mdx create mode 100644 src/pages/sdk/me-client/variables/family.mdx diff --git a/src/pages/sdk/me-client/README.mdx b/src/pages/sdk/me-client/README.mdx index 7247a88..07ff98c 100644 --- a/src/pages/sdk/me-client/README.mdx +++ b/src/pages/sdk/me-client/README.mdx @@ -15,8 +15,12 @@ export const metadata = { ## Interfaces +- [ArchetypeTemplate](interfaces/ArchetypeTemplate.mdx) - [BillableEvent](interfaces/BillableEvent.mdx) - [ComputedFees](interfaces/ComputedFees.mdx) +- [EventSubtypeMetadata](interfaces/EventSubtypeMetadata.mdx) +- [FamilyScopesOptions](interfaces/FamilyScopesOptions.mdx) +- [FamilyScopesResult](interfaces/FamilyScopesResult.mdx) - [Federation](interfaces/Federation.mdx) - [FireEventOptions](interfaces/FireEventOptions.mdx) - [GrantedOptions](interfaces/GrantedOptions.mdx) @@ -32,10 +36,14 @@ export const metadata = { - [SessionPolicy](interfaces/SessionPolicy.mdx) - [SignInOptions](interfaces/SignInOptions.mdx) - [TelemetryEvent](interfaces/TelemetryEvent.mdx) +- [TrustAttestationCount](interfaces/TrustAttestationCount.mdx) - [ValidationResult](interfaces/ValidationResult.mdx) - [VerifyEventResult](interfaces/VerifyEventResult.mdx) - [VerifyOptions](interfaces/VerifyOptions.mdx) - [VerifyResult](interfaces/VerifyResult.mdx) +- [WebhookHeaders](interfaces/WebhookHeaders.mdx) +- [WebhookPayload](interfaces/WebhookPayload.mdx) +- [WithRateLimitRetryOptions](interfaces/WithRateLimitRetryOptions.mdx) ## Type Aliases @@ -45,15 +53,21 @@ export const metadata = { - [ClassCSubtype](type-aliases/ClassCSubtype.mdx) - [EventClass](type-aliases/EventClass.mdx) - [EventSubtype](type-aliases/EventSubtype.mdx) +- [FamilyVerb](type-aliases/FamilyVerb.mdx) - [FederationStatus](type-aliases/FederationStatus.mdx) +- [IntegratorArchetype](type-aliases/IntegratorArchetype.mdx) - [Scope](type-aliases/Scope.mdx) - [SigningMethod](type-aliases/SigningMethod.mdx) - [SiteFeeShape](type-aliases/SiteFeeShape.mdx) ## Variables +- [ALL\_EVENT\_SUBTYPES](variables/ALL_EVENT_SUBTYPES.mdx) +- [ARCHETYPE\_TEMPLATES](variables/ARCHETYPE_TEMPLATES.mdx) - [config](variables/config.mdx) - [event](variables/event.mdx) +- [EVENT\_SUBTYPES](variables/EVENT_SUBTYPES.mdx) +- [family](variables/family.mdx) - [federations](variables/federations.mdx) - [MIN\_INTEGRATOR\_PRICE\_SATS](variables/MIN_INTEGRATOR_PRICE_SATS.mdx) - [oc](variables/oc.mdx) @@ -67,10 +81,15 @@ export const metadata = { - [clearBearerToken](functions/clearBearerToken.mdx) - [computeFees](functions/computeFees.mdx) +- [configFromTemplate](functions/configFromTemplate.mdx) +- [getArchetypeTemplate](functions/getArchetypeTemplate.mdx) - [getBearerToken](functions/getBearerToken.mdx) - [getOrigin](functions/getOrigin.mdx) - [OcSignInButton](functions/OcSignInButton.mdx) - [onTelemetry](functions/onTelemetry.mdx) +- [parseTrustAttestationCount](functions/parseTrustAttestationCount.mdx) - [setBearerToken](functions/setBearerToken.mdx) - [setOrigin](functions/setOrigin.mdx) +- [subtypesForClass](functions/subtypesForClass.mdx) - [validateIntegratorConfig](functions/validateIntegratorConfig.mdx) +- [withRateLimitRetry](functions/withRateLimitRetry.mdx) diff --git a/src/pages/sdk/me-client/classes/MeClientError.mdx b/src/pages/sdk/me-client/classes/MeClientError.mdx index 387c4a9..065a5d3 100644 --- a/src/pages/sdk/me-client/classes/MeClientError.mdx +++ b/src/pages/sdk/me-client/classes/MeClientError.mdx @@ -11,7 +11,7 @@ export const metadata = { # Class: MeClientError -Defined in: [me-client/src/transport.ts:73](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L73) +Defined in: [me-client/src/transport.ts:103](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L103) ## Extends @@ -22,10 +22,16 @@ Defined in: [me-client/src/transport.ts:73](https://github.com/orangecheck/oc-pa ### Constructor ```ts -new MeClientError(message: string, status: number): MeClientError; +new MeClientError( + message: string, + status: number, + opts?: { + errorCode?: string; + retryAfterSeconds?: number; +}): MeClientError; ``` -Defined in: [me-client/src/transport.ts:75](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L75) +Defined in: [me-client/src/transport.ts:114](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L114) #### Parameters @@ -33,6 +39,9 @@ Defined in: [me-client/src/transport.ts:75](https://github.com/orangecheck/oc-pa | ------ | ------ | | `message` | `string` | | `status` | `number` | +| `opts?` | \{ `errorCode?`: `string`; `retryAfterSeconds?`: `number`; \} | +| `opts.errorCode?` | `string` | +| `opts.retryAfterSeconds?` | `number` | #### Returns @@ -48,110 +57,28 @@ Error.constructor | Property | Modifier | Type | Description | Inherited from | Defined in | | ------ | ------ | ------ | ------ | ------ | ------ | +| <a id="property-errorcode"></a> `errorCode` | `readonly` | `string` \| `undefined` | Server-side error code (the `error` field on the JSON body, e.g. `project_rate_limit_exceeded`). Stable across versions; safe to match on. The human-readable `message` may change. | - | [me-client/src/transport.ts:108](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L108) | | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | | <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| <a id="property-retryafterseconds"></a> `retryAfterSeconds` | `readonly` | `number` \| `undefined` | Seconds to wait before retrying. Set when the server responded 429 with a Retry-After header (or a `retry_after_seconds` body field). Undefined for any other status. Use with `withRateLimitRetry()` or your own backoff loop. | - | [me-client/src/transport.ts:113](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L113) | | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| <a id="property-status"></a> `status` | `readonly` | `number` | - | - | [me-client/src/transport.ts:74](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L74) | -| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | me-client/node\_modules/@types/node/globals.d.ts:68 | +| <a id="property-status"></a> `status` | `readonly` | `number` | - | - | [me-client/src/transport.ts:104](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L104) | -## Methods +## Accessors -### captureStackTrace() +### isRateLimited -```ts -static captureStackTrace(targetObject: object, constructorOpt?: Function): void; -``` - -Defined in: me-client/node\_modules/@types/node/globals.d.ts:52 - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. - -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` - -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. - -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. - -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: - -```js -function a() { - b(); -} - -function b() { - c(); -} - -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} - -a(); -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -```ts -Error.captureStackTrace -``` - -*** - -### prepareStackTrace() +#### Get Signature ```ts -static prepareStackTrace(err: Error, stackTraces: CallSite[]): any; +get isRateLimited(): boolean; ``` -Defined in: me-client/node\_modules/@types/node/globals.d.ts:56 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See +Defined in: [me-client/src/transport.ts:127](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L127) -https://v8.dev/docs/stack-trace-api#customizing-stack-traces +True for the 429 surface · convenience boolean so callers don't + have to compare status === 429 every time. -#### Inherited from +##### Returns -```ts -Error.prepareStackTrace -``` +`boolean` diff --git a/src/pages/sdk/me-client/functions/OcSignInButton.mdx b/src/pages/sdk/me-client/functions/OcSignInButton.mdx index ac916b7..e893644 100644 --- a/src/pages/sdk/me-client/functions/OcSignInButton.mdx +++ b/src/pages/sdk/me-client/functions/OcSignInButton.mdx @@ -12,7 +12,7 @@ export const metadata = { # Function: OcSignInButton() ```ts -function OcSignInButton(__namedParameters: OcSignInButtonProps): Element; +function OcSignInButton(__namedParameters: OcSignInButtonProps): any; ``` Defined in: [me-client/src/SignInButton.tsx:29](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L29) @@ -34,4 +34,4 @@ useOcSession() across the rest of the app. ## Returns -`Element` +`any` diff --git a/src/pages/sdk/me-client/functions/computeFees.mdx b/src/pages/sdk/me-client/functions/computeFees.mdx index 9a14e06..383f121 100644 --- a/src/pages/sdk/me-client/functions/computeFees.mdx +++ b/src/pages/sdk/me-client/functions/computeFees.mdx @@ -15,7 +15,7 @@ export const metadata = { function computeFees(cfg: IntegratorEventConfig, payment_amount_sats?: number): ComputedFees; ``` -Defined in: [me-client/src/types.ts:110](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L110) +Defined in: [me-client/src/types.ts:120](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L120) Compute the four-way fee split for an event given an integrator's config and (for percent_of_amount events) the underlying payment diff --git a/src/pages/sdk/me-client/functions/configFromTemplate.mdx b/src/pages/sdk/me-client/functions/configFromTemplate.mdx new file mode 100644 index 0000000..1bab2d7 --- /dev/null +++ b/src/pages/sdk/me-client/functions/configFromTemplate.mdx @@ -0,0 +1,38 @@ +export const metadata = { + title: "Function: configFromTemplate()", + description: "Auto-generated API reference for Function: configFromTemplate(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / configFromTemplate + +# Function: configFromTemplate() + +```ts +function configFromTemplate(useCase: IntegratorArchetype, identity: ProjectIdentity): IntegratorPriceConfig; +``` + +Defined in: [me-client/src/templates.ts:292](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L292) + +Build a complete IntegratorPriceConfig from an archetype id + the +project's identity fields. Every subtype gets an entry — the +archetype's listed subtypes get the template's pricing; everything +else gets `enabled: false` with conservative defaults so the config +is type-complete and the integrator can flip-on later subtypes +without re-deriving prices. + +Throws synchronously if `useCase` isn't a known archetype id. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `useCase` | [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx) | +| `identity` | `ProjectIdentity` | + +## Returns + +[`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx) diff --git a/src/pages/sdk/me-client/functions/getArchetypeTemplate.mdx b/src/pages/sdk/me-client/functions/getArchetypeTemplate.mdx new file mode 100644 index 0000000..943dd82 --- /dev/null +++ b/src/pages/sdk/me-client/functions/getArchetypeTemplate.mdx @@ -0,0 +1,31 @@ +export const metadata = { + title: "Function: getArchetypeTemplate()", + description: "Auto-generated API reference for Function: getArchetypeTemplate(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / getArchetypeTemplate + +# Function: getArchetypeTemplate() + +```ts +function getArchetypeTemplate(id: IntegratorArchetype): ArchetypeTemplate; +``` + +Defined in: [me-client/src/templates.ts:319](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L319) + +Look up a template's metadata · used by config-editor UIs to render + "you're on the X template · here's what it enables" copy. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `id` | [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx) | + +## Returns + +[`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx) diff --git a/src/pages/sdk/me-client/functions/parseTrustAttestationCount.mdx b/src/pages/sdk/me-client/functions/parseTrustAttestationCount.mdx new file mode 100644 index 0000000..39147a3 --- /dev/null +++ b/src/pages/sdk/me-client/functions/parseTrustAttestationCount.mdx @@ -0,0 +1,36 @@ +export const metadata = { + title: "Function: parseTrustAttestationCount()", + description: "Auto-generated API reference for Function: parseTrustAttestationCount(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / parseTrustAttestationCount + +# Function: parseTrustAttestationCount() + +```ts +function parseTrustAttestationCount(value: string): + | TrustAttestationCount + | null; +``` + +Defined in: [me-client/src/scope.ts:84](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L84) + +Decode the `trust_attestation_count` scope's wire-format string into + a typed quad. Returns null if the input is malformed (defensive · + the resolver always emits well-formed strings, but third-party + consumers may hand us anything). + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `value` | `string` | + +## Returns + + \| [`TrustAttestationCount`](../interfaces/TrustAttestationCount.mdx) + \| `null` diff --git a/src/pages/sdk/me-client/functions/subtypesForClass.mdx b/src/pages/sdk/me-client/functions/subtypesForClass.mdx new file mode 100644 index 0000000..6fb2ce7 --- /dev/null +++ b/src/pages/sdk/me-client/functions/subtypesForClass.mdx @@ -0,0 +1,30 @@ +export const metadata = { + title: "Function: subtypesForClass()", + description: "Auto-generated API reference for Function: subtypesForClass(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / subtypesForClass + +# Function: subtypesForClass() + +```ts +function subtypesForClass(cls: EventClass): EventSubtypeMetadata[]; +``` + +Defined in: [me-client/src/subtypes.ts:179](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L179) + +All subtypes for a given class · convenience accessor. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `cls` | [`EventClass`](../type-aliases/EventClass.mdx) | + +## Returns + +[`EventSubtypeMetadata`](../interfaces/EventSubtypeMetadata.mdx)[] diff --git a/src/pages/sdk/me-client/functions/validateIntegratorConfig.mdx b/src/pages/sdk/me-client/functions/validateIntegratorConfig.mdx index 2fffd46..70ccc94 100644 --- a/src/pages/sdk/me-client/functions/validateIntegratorConfig.mdx +++ b/src/pages/sdk/me-client/functions/validateIntegratorConfig.mdx @@ -15,7 +15,7 @@ export const metadata = { function validateIntegratorConfig(cfg: IntegratorPriceConfig): ValidationResult; ``` -Defined in: [me-client/src/types.ts:147](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L147) +Defined in: [me-client/src/types.ts:157](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L157) Validate an integrator's pricing config against the platform's non-negotiable rules. Run client-side before posting; the server runs diff --git a/src/pages/sdk/me-client/functions/withRateLimitRetry.mdx b/src/pages/sdk/me-client/functions/withRateLimitRetry.mdx new file mode 100644 index 0000000..c5f571a --- /dev/null +++ b/src/pages/sdk/me-client/functions/withRateLimitRetry.mdx @@ -0,0 +1,58 @@ +export const metadata = { + title: "Function: withRateLimitRetry()", + description: "Auto-generated API reference for Function: withRateLimitRetry(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / withRateLimitRetry + +# Function: withRateLimitRetry() + +```ts +function withRateLimitRetry(fn: () => Promise, opts?: WithRateLimitRetryOptions): Promise; +``` + +Defined in: [me-client/src/transport.ts:170](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L170) + +Wrap a transport call with automatic 429 retry, honoring Retry-After. + + import { oc, withRateLimitRetry } from '@orangecheck/me-client'; + + const res = await withRateLimitRetry(() => + oc.event.fireBatch({ project_key, events }) + ); + +Retries ONLY on 429 (rate-limit) responses. All other errors throw +immediately so the caller can handle them. Sleeps for `Retry-After` +seconds when present (capped at `maxRetryAfterSeconds`); otherwise +uses exponential backoff from `baseBackoffMs`. + +Per OCHK-V3-PLAN §12.6 — backpressure protocol. The server emits +429 + Retry-After when a project crosses its 1000 events/sec sustained +cap; this helper honors it without integrators having to write the +sleep loop. + +Idempotency note: integrators using `event.fireBatch` should pass an +`idempotency_key` per event so a retry doesn't double-record. The +server collapses retried events to a `duplicate` status with the +prior payload. + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `fn` | () => `Promise`\<`T`\> | +| `opts` | [`WithRateLimitRetryOptions`](../interfaces/WithRateLimitRetryOptions.mdx) | + +## Returns + +`Promise`\<`T`\> diff --git a/src/pages/sdk/me-client/interfaces/ArchetypeTemplate.mdx b/src/pages/sdk/me-client/interfaces/ArchetypeTemplate.mdx new file mode 100644 index 0000000..c31bdd3 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/ArchetypeTemplate.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Interface: ArchetypeTemplate", + description: "Auto-generated API reference for Interface: ArchetypeTemplate. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / ArchetypeTemplate + +# Interface: ArchetypeTemplate + +Defined in: [me-client/src/templates.ts:56](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L56) + +Template descriptor · what each archetype enables and prices. + Exposed so dashboards can render "you're using the X template" + state and offer one-click swaps. + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-events"></a> `events` | `Partial`\<`Record`\<[`EventSubtype`](../type-aliases/EventSubtype.mdx), [`IntegratorEventConfig`](IntegratorEventConfig.mdx)\>\> | Per-subtype config the template emits. Subtypes not listed are emitted as `enabled: false` (the SDK fills them with a conservative default to keep the type happy without firing). | [me-client/src/templates.ts:66](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L66) | +| <a id="property-examples"></a> `examples` | readonly `string`[] | Concrete examples of sites this archetype fits. | [me-client/src/templates.ts:62](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L62) | +| <a id="property-id"></a> `id` | [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx) | - | [me-client/src/templates.ts:57](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L57) | +| <a id="property-label"></a> `label` | `string` | - | [me-client/src/templates.ts:58](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L58) | +| <a id="property-summary"></a> `summary` | `string` | One-sentence summary shown next to the picker. | [me-client/src/templates.ts:60](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L60) | diff --git a/src/pages/sdk/me-client/interfaces/BillableEvent.mdx b/src/pages/sdk/me-client/interfaces/BillableEvent.mdx index dd4d3e6..3252ee8 100644 --- a/src/pages/sdk/me-client/interfaces/BillableEvent.mdx +++ b/src/pages/sdk/me-client/interfaces/BillableEvent.mdx @@ -11,21 +11,26 @@ export const metadata = { # Interface: BillableEvent -Defined in: [me-client/src/types.ts:190](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L190) +Defined in: [me-client/src/types.ts:200](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L200) + +## Extended by + +- [`WebhookPayload`](WebhookPayload.mdx) ## Properties -| Property | Type | Defined in | -| ------ | ------ | ------ | -| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | [me-client/src/types.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L193) | -| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | [me-client/src/types.ts:196](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L196) | -| <a id="property-id"></a> `id` | `string` | [me-client/src/types.ts:191](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L191) | -| <a id="property-occurred_at"></a> `occurred_at` | `string` | [me-client/src/types.ts:192](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L192) | -| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | [me-client/src/types.ts:197](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L197) | -| <a id="property-site"></a> `site` | \{ `display_name`: `string`; `domain`: `string`; \} | [me-client/src/types.ts:195](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L195) | -| `site.display_name` | `string` | [me-client/src/types.ts:195](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L195) | -| `site.domain` | `string` | [me-client/src/types.ts:195](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L195) | -| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | [me-client/src/types.ts:199](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L199) | -| <a id="property-subtype"></a> `subtype` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | [me-client/src/types.ts:194](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L194) | -| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | [me-client/src/types.ts:198](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L198) | -| <a id="property-verify_url"></a> `verify_url` | `string` | [me-client/src/types.ts:200](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L200) | +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | - | [me-client/src/types.ts:203](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L203) | +| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | [me-client/src/types.ts:206](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L206) | +| <a id="property-id"></a> `id` | `string` | - | [me-client/src/types.ts:201](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L201) | +| <a id="property-is_agent"></a> `is_agent?` | `boolean` | Per OCHK-V3-PLAN §7 phase-1 · true when the event was fired by an oc-agent delegation rather than a human session. The integrator's IntegratorEventConfig.agent block may price these differently or refuse them. Optional · canonical encoder branches to v=3 only when present, so legacy human-fired events keep their v=2 hash + signature. | [me-client/src/types.ts:217](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L217) | +| <a id="property-occurred_at"></a> `occurred_at` | `string` | - | [me-client/src/types.ts:202](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L202) | +| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | - | [me-client/src/types.ts:207](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L207) | +| <a id="property-site"></a> `site` | \{ `display_name`: `string`; `domain`: `string`; \} | - | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| `site.display_name` | `string` | - | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| `site.domain` | `string` | - | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | - | [me-client/src/types.ts:209](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L209) | +| <a id="property-subtype"></a> `subtype` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | - | [me-client/src/types.ts:204](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L204) | +| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | - | [me-client/src/types.ts:208](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L208) | +| <a id="property-verify_url"></a> `verify_url` | `string` | - | [me-client/src/types.ts:210](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L210) | diff --git a/src/pages/sdk/me-client/interfaces/ComputedFees.mdx b/src/pages/sdk/me-client/interfaces/ComputedFees.mdx index bbe6b66..d23ad28 100644 --- a/src/pages/sdk/me-client/interfaces/ComputedFees.mdx +++ b/src/pages/sdk/me-client/interfaces/ComputedFees.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: ComputedFees -Defined in: [me-client/src/types.ts:92](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L92) +Defined in: [me-client/src/types.ts:102](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L102) A computed fee breakdown for a single event. site_rebate_sats is what flows back to the integrator's OC balance after OC's platform fee and @@ -21,7 +21,7 @@ A computed fee breakdown for a single event. site_rebate_sats is what | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | [me-client/src/types.ts:93](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L93) | -| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | [me-client/src/types.ts:94](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L94) | -| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | [me-client/src/types.ts:96](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L96) | -| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | [me-client/src/types.ts:95](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L95) | +| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | [me-client/src/types.ts:103](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L103) | +| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | [me-client/src/types.ts:104](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L104) | +| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | [me-client/src/types.ts:106](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L106) | +| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | [me-client/src/types.ts:105](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L105) | diff --git a/src/pages/sdk/me-client/interfaces/EventSubtypeMetadata.mdx b/src/pages/sdk/me-client/interfaces/EventSubtypeMetadata.mdx new file mode 100644 index 0000000..db81ecc --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/EventSubtypeMetadata.mdx @@ -0,0 +1,26 @@ +export const metadata = { + title: "Interface: EventSubtypeMetadata", + description: "Auto-generated API reference for Interface: EventSubtypeMetadata. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / EventSubtypeMetadata + +# Interface: EventSubtypeMetadata + +Defined in: [me-client/src/subtypes.ts:29](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L29) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | - | [me-client/src/subtypes.ts:31](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L31) | +| <a id="property-common_use_cases"></a> `common_use_cases` | readonly `string`[] | Common use cases · lets integrators search their own product for matching flows. Two-three terms each, lowercase. | [me-client/src/subtypes.ts:43](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L43) | +| <a id="property-example"></a> `example` | `string` | A concrete example from a typical SaaS · helps integrators map an unfamiliar subtype name to a real flow they recognize. | [me-client/src/subtypes.ts:40](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L40) | +| <a id="property-fires_when"></a> `fires_when` | `string` | When this fires · imperative-mood plain English. The integrator reads this to know which event in their codebase should call `oc.event.fire()` with this subtype. | [me-client/src/subtypes.ts:37](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L37) | +| <a id="property-id"></a> `id` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | - | [me-client/src/subtypes.ts:30](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L30) | +| <a id="property-label"></a> `label` | `string` | Short label · matches SUBTYPE_LABELS on the server. | [me-client/src/subtypes.ts:33](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L33) | +| <a id="property-typical_price_hint"></a> `typical_price_hint` | `string` | What an integrator typically pays for this subtype, anchored at $1 ≈ 1052 sats. Returns null for percent-of-amount subtypes where the price scales with the underlying transaction. | [me-client/src/subtypes.ts:47](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L47) | diff --git a/src/pages/sdk/me-client/interfaces/FamilyScopesOptions.mdx b/src/pages/sdk/me-client/interfaces/FamilyScopesOptions.mdx new file mode 100644 index 0000000..155958f --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/FamilyScopesOptions.mdx @@ -0,0 +1,21 @@ +export const metadata = { + title: "Interface: FamilyScopesOptions", + description: "Auto-generated API reference for Interface: FamilyScopesOptions. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / FamilyScopesOptions + +# Interface: FamilyScopesOptions + +Defined in: [me-client/src/family.ts:42](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L42) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-origin"></a> `origin?` | `string` | Override the OC family origin · only useful for staging. Defaults to https://me.ochk.io · the family-side scope reads always go to me.ochk regardless of which sibling is calling. | [me-client/src/family.ts:46](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L46) | +| <a id="property-signal"></a> `signal?` | `AbortSignal` | - | [me-client/src/family.ts:47](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L47) | diff --git a/src/pages/sdk/me-client/interfaces/FamilyScopesResult.mdx b/src/pages/sdk/me-client/interfaces/FamilyScopesResult.mdx new file mode 100644 index 0000000..1bfac34 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/FamilyScopesResult.mdx @@ -0,0 +1,26 @@ +export const metadata = { + title: "Interface: FamilyScopesResult", + description: "Auto-generated API reference for Interface: FamilyScopesResult. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / FamilyScopesResult + +# Interface: FamilyScopesResult + +Defined in: [me-client/src/family.ts:50](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L50) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-family_product"></a> `family_product` | \{ `name`: `string`; `origin`: `string`; `verb`: [`FamilyVerb`](../type-aliases/FamilyVerb.mdx); \} | Sibling product the grants are scoped to (echoed for logging / debug). | [me-client/src/family.ts:57](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L57) | +| `family_product.name` | `string` | - | [me-client/src/family.ts:59](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L59) | +| `family_product.origin` | `string` | - | [me-client/src/family.ts:60](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L60) | +| `family_product.verb` | [`FamilyVerb`](../type-aliases/FamilyVerb.mdx) | - | [me-client/src/family.ts:58](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L58) | +| <a id="property-scopes"></a> `scopes` | `Partial`\<`Record`\<[`Scope`](../type-aliases/Scope.mdx), `string`\>\> | Resolved values for the granted scopes. Only fields whose scope is in `scopes_granted` are present. | [me-client/src/family.ts:67](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L67) | +| <a id="property-scopes_granted"></a> `scopes_granted` | [`Scope`](../type-aliases/Scope.mdx)[] | Scopes the user has actively granted to this sibling. Subset of the requested set, filtered for not-revoked + not-expired. | [me-client/src/family.ts:64](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L64) | +| <a id="property-sub"></a> `sub` | `string` | Per-sibling stable subject for the currently-signed-in user. Anonymous · derived from master_addr + the family:<verb> project_key. Sibling backends key on this. | [me-client/src/family.ts:54](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L54) | diff --git a/src/pages/sdk/me-client/interfaces/Federation.mdx b/src/pages/sdk/me-client/interfaces/Federation.mdx index 0d5281e..2f0c892 100644 --- a/src/pages/sdk/me-client/interfaces/Federation.mdx +++ b/src/pages/sdk/me-client/interfaces/Federation.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: Federation -Defined in: [me-client/src/types.ts:266](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L266) +Defined in: [me-client/src/types.ts:361](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L361) Federation directory entry. Mirrors `oc-me-web/src/lib/federations/registry.ts` field-for-field; this package is the public consumption shape. @@ -20,18 +20,18 @@ Federation directory entry. Mirrors `oc-me-web/src/lib/federations/registry.ts` | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-apply_cta"></a> `apply_cta?` | `string` | - | [me-client/src/types.ts:286](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L286) | -| <a id="property-apply_href"></a> `apply_href?` | `string` | - | [me-client/src/types.ts:287](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L287) | -| <a id="property-ceremony_window"></a> `ceremony_window?` | `string` | - | [me-client/src/types.ts:284](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L284) | -| <a id="property-charter_hash"></a> `charter_hash` | `string` \| `null` | SHA-256 of the canonical federation charter, hex-encoded. | [me-client/src/types.ts:275](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L275) | -| <a id="property-charter_status"></a> `charter_status?` | `string` | - | [me-client/src/types.ts:283](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L283) | -| <a id="property-geography_hint"></a> `geography_hint` | `string` | - | [me-client/src/types.ts:278](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L278) | -| <a id="property-geography_requirements"></a> `geography_requirements?` | `string` | - | [me-client/src/types.ts:282](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L282) | -| <a id="property-invite"></a> `invite` | `string` \| `null` | Fedimint invite code; null until status === 'live'. | [me-client/src/types.ts:273](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L273) | -| <a id="property-last_attestation_at"></a> `last_attestation_at` | `string` \| `null` | ISO-8601 of the most recent ongoing-attestation envelope. | [me-client/src/types.ts:277](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L277) | -| <a id="property-name"></a> `name` | `string` | - | [me-client/src/types.ts:268](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L268) | -| <a id="property-slug"></a> `slug` | `string` | - | [me-client/src/types.ts:267](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L267) | -| <a id="property-status"></a> `status` | [`FederationStatus`](../type-aliases/FederationStatus.mdx) | - | [me-client/src/types.ts:269](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L269) | -| <a id="property-target_guardian_count"></a> `target_guardian_count` | `number` | - | [me-client/src/types.ts:271](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L271) | -| <a id="property-threshold"></a> `threshold` | `string` | - | [me-client/src/types.ts:270](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L270) | -| <a id="property-why_this_one"></a> `why_this_one?` | `string` | - | [me-client/src/types.ts:285](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L285) | +| <a id="property-apply_cta"></a> `apply_cta?` | `string` | - | [me-client/src/types.ts:381](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L381) | +| <a id="property-apply_href"></a> `apply_href?` | `string` | - | [me-client/src/types.ts:382](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L382) | +| <a id="property-ceremony_window"></a> `ceremony_window?` | `string` | - | [me-client/src/types.ts:379](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L379) | +| <a id="property-charter_hash"></a> `charter_hash` | `string` \| `null` | SHA-256 of the canonical federation charter, hex-encoded. | [me-client/src/types.ts:370](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L370) | +| <a id="property-charter_status"></a> `charter_status?` | `string` | - | [me-client/src/types.ts:378](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L378) | +| <a id="property-geography_hint"></a> `geography_hint` | `string` | - | [me-client/src/types.ts:373](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L373) | +| <a id="property-geography_requirements"></a> `geography_requirements?` | `string` | - | [me-client/src/types.ts:377](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L377) | +| <a id="property-invite"></a> `invite` | `string` \| `null` | Fedimint invite code; null until status === 'live'. | [me-client/src/types.ts:368](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L368) | +| <a id="property-last_attestation_at"></a> `last_attestation_at` | `string` \| `null` | ISO-8601 of the most recent ongoing-attestation envelope. | [me-client/src/types.ts:372](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L372) | +| <a id="property-name"></a> `name` | `string` | - | [me-client/src/types.ts:363](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L363) | +| <a id="property-slug"></a> `slug` | `string` | - | [me-client/src/types.ts:362](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L362) | +| <a id="property-status"></a> `status` | [`FederationStatus`](../type-aliases/FederationStatus.mdx) | - | [me-client/src/types.ts:364](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L364) | +| <a id="property-target_guardian_count"></a> `target_guardian_count` | `number` | - | [me-client/src/types.ts:366](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L366) | +| <a id="property-threshold"></a> `threshold` | `string` | - | [me-client/src/types.ts:365](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L365) | +| <a id="property-why_this_one"></a> `why_this_one?` | `string` | - | [me-client/src/types.ts:380](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L380) | diff --git a/src/pages/sdk/me-client/interfaces/FireEventOptions.mdx b/src/pages/sdk/me-client/interfaces/FireEventOptions.mdx index 51ae3e8..62c4195 100644 --- a/src/pages/sdk/me-client/interfaces/FireEventOptions.mdx +++ b/src/pages/sdk/me-client/interfaces/FireEventOptions.mdx @@ -18,6 +18,7 @@ Defined in: [me-client/src/event.ts:38](https://github.com/orangecheck/oc-packag | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | | <a id="property-action_label"></a> `action_label?` | `string` | Human-readable action label that appears on the envelope. Optional but encouraged — it's what the user sees in their /me/earn ledger. | [me-client/src/event.ts:46](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L46) | +| <a id="property-is_agent"></a> `is_agent?` | `boolean` | Per OCHK-V3-PLAN §7 phase-1 · when true, the event was fired by an oc-agent delegation rather than a human acting under their own session. The integrator's IntegratorEventConfig.agent block applies the override (or refuses · 422 agent_refused). Set this when an autonomous agent (oc-agent kind 30084 action envelope) is the source of the event. Don't set it for events the human user clicked themselves. | [me-client/src/event.ts:66](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L66) | | <a id="property-metadata"></a> `metadata?` | `Record`\<`string`, `unknown`\> | Free-form metadata stored on the envelope. Public — anyone who GETs /api/envelope/<id> sees it. Don't put secrets here. | [me-client/src/event.ts:57](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L57) | | <a id="property-payment_amount_sats"></a> `payment_amount_sats?` | `number` | For percent_of_amount-priced subtypes, the underlying amount the fee is computed against. Required for those subtypes. | [me-client/src/event.ts:49](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L49) | | <a id="property-project_key"></a> `project_key` | `string` | Your project_key (e.g. `pk_live_yourcompany`). Required. | [me-client/src/event.ts:40](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L40) | diff --git a/src/pages/sdk/me-client/interfaces/GrantedOptions.mdx b/src/pages/sdk/me-client/interfaces/GrantedOptions.mdx index 57b54a5..0767541 100644 --- a/src/pages/sdk/me-client/interfaces/GrantedOptions.mdx +++ b/src/pages/sdk/me-client/interfaces/GrantedOptions.mdx @@ -11,11 +11,11 @@ export const metadata = { # Interface: GrantedOptions -Defined in: [me-client/src/scope.ts:48](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L48) +Defined in: [me-client/src/scope.ts:97](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L97) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-project_key"></a> `project_key` | `string` | Your project_key. Required. | [me-client/src/scope.ts:50](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L50) | -| <a id="property-signal"></a> `signal?` | `AbortSignal` | - | [me-client/src/scope.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L51) | +| <a id="property-project_key"></a> `project_key` | `string` | Your project_key. Required. | [me-client/src/scope.ts:99](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L99) | +| <a id="property-signal"></a> `signal?` | `AbortSignal` | - | [me-client/src/scope.ts:100](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L100) | diff --git a/src/pages/sdk/me-client/interfaces/GrantedResult.mdx b/src/pages/sdk/me-client/interfaces/GrantedResult.mdx index 5380c9a..24b818c 100644 --- a/src/pages/sdk/me-client/interfaces/GrantedResult.mdx +++ b/src/pages/sdk/me-client/interfaces/GrantedResult.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: GrantedResult -Defined in: [me-client/src/scope.ts:54](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L54) +Defined in: [me-client/src/scope.ts:103](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L103) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-scopes"></a> `scopes` | `Partial`\<`Record`\<[`Scope`](../type-aliases/Scope.mdx), `string`\>\> | Resolved values for the granted scopes. Only fields whose scope is in `scopes_granted` are present. | [me-client/src/scope.ts:64](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L64) | -| <a id="property-scopes_granted"></a> `scopes_granted` | [`Scope`](../type-aliases/Scope.mdx)[] | Scopes the user has actively granted to this project. Subset of the requested scopes, filtered for not-revoked + not-expired. | [me-client/src/scope.ts:61](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L61) | -| <a id="property-sub"></a> `sub` | `string` | Per-integrator stable subject for the currently-signed-in user. This is what your backend should key user records on (NOT the master addr · which OC doesn't reveal). | [me-client/src/scope.ts:58](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L58) | +| <a id="property-scopes"></a> `scopes` | `Partial`\<`Record`\<[`Scope`](../type-aliases/Scope.mdx), `string`\>\> | Resolved values for the granted scopes. Only fields whose scope is in `scopes_granted` are present. | [me-client/src/scope.ts:113](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L113) | +| <a id="property-scopes_granted"></a> `scopes_granted` | [`Scope`](../type-aliases/Scope.mdx)[] | Scopes the user has actively granted to this project. Subset of the requested scopes, filtered for not-revoked + not-expired. | [me-client/src/scope.ts:110](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L110) | +| <a id="property-sub"></a> `sub` | `string` | Per-integrator stable subject for the currently-signed-in user. This is what your backend should key user records on (NOT the master addr · which OC doesn't reveal). | [me-client/src/scope.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L107) | diff --git a/src/pages/sdk/me-client/interfaces/IntegratorEventConfig.mdx b/src/pages/sdk/me-client/interfaces/IntegratorEventConfig.mdx index 49995ef..e959d67 100644 --- a/src/pages/sdk/me-client/interfaces/IntegratorEventConfig.mdx +++ b/src/pages/sdk/me-client/interfaces/IntegratorEventConfig.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: IntegratorEventConfig -Defined in: [me-client/src/types.ts:65](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L65) +Defined in: [me-client/src/types.ts:75](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L75) What an integrator declares for a single event subtype. @@ -19,6 +19,6 @@ What an integrator declares for a single event subtype. | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-enabled"></a> `enabled` | `boolean` | Whether this site bills this event subtype at all. | [me-client/src/types.ts:67](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L67) | -| <a id="property-site_pays"></a> `site_pays` | [`SiteFeeShape`](../type-aliases/SiteFeeShape.mdx) | The per-event fee the site pays. | [me-client/src/types.ts:69](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L69) | -| <a id="property-user_share_pct"></a> `user_share_pct` | `number` | Fraction of post-platform-fee that flows to the user (0–0.8 since platform_fee is 20%). The remainder is a rebate to the site's OC project balance. | [me-client/src/types.ts:73](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L73) | +| <a id="property-enabled"></a> `enabled` | `boolean` | Whether this site bills this event subtype at all. | [me-client/src/types.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L77) | +| <a id="property-site_pays"></a> `site_pays` | [`SiteFeeShape`](../type-aliases/SiteFeeShape.mdx) | The per-event fee the site pays. | [me-client/src/types.ts:79](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L79) | +| <a id="property-user_share_pct"></a> `user_share_pct` | `number` | Fraction of post-platform-fee that flows to the user (0–0.8 since platform_fee is 20%). The remainder is a rebate to the site's OC project balance. | [me-client/src/types.ts:83](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L83) | diff --git a/src/pages/sdk/me-client/interfaces/IntegratorPriceConfig.mdx b/src/pages/sdk/me-client/interfaces/IntegratorPriceConfig.mdx index fdab798..288072d 100644 --- a/src/pages/sdk/me-client/interfaces/IntegratorPriceConfig.mdx +++ b/src/pages/sdk/me-client/interfaces/IntegratorPriceConfig.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: IntegratorPriceConfig -Defined in: [me-client/src/types.ts:79](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L79) +Defined in: [me-client/src/types.ts:89](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L89) A complete integrator pricing config. Posted to me.ochk.io once at integration time, mutable via the configurator UI or this SDK any time @@ -21,8 +21,8 @@ A complete integrator pricing config. Posted to me.ochk.io once at | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-display_name"></a> `display_name` | `string` | - | [me-client/src/types.ts:81](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L81) | -| <a id="property-domain"></a> `domain` | `string` | - | [me-client/src/types.ts:82](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L82) | -| <a id="property-events"></a> `events` | `Partial`\<`Record`\<[`EventSubtype`](../type-aliases/EventSubtype.mdx), [`IntegratorEventConfig`](IntegratorEventConfig.mdx)\>\> | Per-subtype configs. Subtypes not listed are disabled by default. | [me-client/src/types.ts:86](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L86) | -| <a id="property-project_key"></a> `project_key` | `string` | - | [me-client/src/types.ts:80](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L80) | -| <a id="property-updated_at"></a> `updated_at` | `string` | ISO-8601 timestamp the config was last updated. | [me-client/src/types.ts:84](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L84) | +| <a id="property-display_name"></a> `display_name` | `string` | - | [me-client/src/types.ts:91](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L91) | +| <a id="property-domain"></a> `domain` | `string` | - | [me-client/src/types.ts:92](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L92) | +| <a id="property-events"></a> `events` | `Partial`\<`Record`\<[`EventSubtype`](../type-aliases/EventSubtype.mdx), [`IntegratorEventConfig`](IntegratorEventConfig.mdx)\>\> | Per-subtype configs. Subtypes not listed are disabled by default. | [me-client/src/types.ts:96](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L96) | +| <a id="property-project_key"></a> `project_key` | `string` | - | [me-client/src/types.ts:90](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L90) | +| <a id="property-updated_at"></a> `updated_at` | `string` | ISO-8601 timestamp the config was last updated. | [me-client/src/types.ts:94](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L94) | diff --git a/src/pages/sdk/me-client/interfaces/OcSignInButtonProps.mdx b/src/pages/sdk/me-client/interfaces/OcSignInButtonProps.mdx index 746340b..17494dc 100644 --- a/src/pages/sdk/me-client/interfaces/OcSignInButtonProps.mdx +++ b/src/pages/sdk/me-client/interfaces/OcSignInButtonProps.mdx @@ -17,287 +17,27 @@ Defined in: [me-client/src/SignInButton.tsx:6](https://github.com/orangecheck/oc - `Omit`\<`React.ButtonHTMLAttributes`\<`HTMLButtonElement`\>, `"onError"`\> +## Indexable + +```ts +[key: string]: ButtonHTMLAttributes +``` + +```ts +[key: number]: ButtonHTMLAttributes +``` + +```ts +[key: symbol]: ButtonHTMLAttributes +``` + ## Properties -| Property | Type | Description | Inherited from | Defined in | -| ------ | ------ | ------ | ------ | ------ | -| <a id="property-about"></a> `about?` | `string` | - | `Omit.about` | me-client/node\_modules/@types/react/index.d.ts:2939 | -| <a id="property-accesskey"></a> `accessKey?` | `string` | - | `Omit.accessKey` | me-client/node\_modules/@types/react/index.d.ts:2912 | -| <a id="property-aria-activedescendant"></a> `aria-activedescendant?` | `string` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | `Omit.aria-activedescendant` | me-client/node\_modules/@types/react/index.d.ts:2610 | -| <a id="property-aria-atomic"></a> `aria-atomic?` | `Booleanish` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | `Omit.aria-atomic` | me-client/node\_modules/@types/react/index.d.ts:2612 | -| <a id="property-aria-autocomplete"></a> `aria-autocomplete?` | `"none"` \| `"list"` \| `"inline"` \| `"both"` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | `Omit.aria-autocomplete` | me-client/node\_modules/@types/react/index.d.ts:2617 | -| <a id="property-aria-braillelabel"></a> `aria-braillelabel?` | `string` | Defines a string value that labels the current element, which is intended to be converted into Braille. **See** aria-label. | `Omit.aria-braillelabel` | me-client/node\_modules/@types/react/index.d.ts:2623 | -| <a id="property-aria-brailleroledescription"></a> `aria-brailleroledescription?` | `string` | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. **See** aria-roledescription. | `Omit.aria-brailleroledescription` | me-client/node\_modules/@types/react/index.d.ts:2628 | -| <a id="property-aria-busy"></a> `aria-busy?` | `Booleanish` | - | `Omit.aria-busy` | me-client/node\_modules/@types/react/index.d.ts:2629 | -| <a id="property-aria-checked"></a> `aria-checked?` | `boolean` \| `"true"` \| `"false"` \| `"mixed"` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. **See** - aria-pressed - aria-selected. | `Omit.aria-checked` | me-client/node\_modules/@types/react/index.d.ts:2634 | -| <a id="property-aria-colcount"></a> `aria-colcount?` | `number` | Defines the total number of columns in a table, grid, or treegrid. **See** aria-colindex. | `Omit.aria-colcount` | me-client/node\_modules/@types/react/index.d.ts:2639 | -| <a id="property-aria-colindex"></a> `aria-colindex?` | `number` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. **See** - aria-colcount - aria-colspan. | `Omit.aria-colindex` | me-client/node\_modules/@types/react/index.d.ts:2644 | -| <a id="property-aria-colindextext"></a> `aria-colindextext?` | `string` | Defines a human readable text alternative of aria-colindex. **See** aria-rowindextext. | `Omit.aria-colindextext` | me-client/node\_modules/@types/react/index.d.ts:2649 | -| <a id="property-aria-colspan"></a> `aria-colspan?` | `number` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. **See** - aria-colindex - aria-rowspan. | `Omit.aria-colspan` | me-client/node\_modules/@types/react/index.d.ts:2654 | -| <a id="property-aria-controls"></a> `aria-controls?` | `string` | Identifies the element (or elements) whose contents or presence are controlled by the current element. **See** aria-owns. | `Omit.aria-controls` | me-client/node\_modules/@types/react/index.d.ts:2659 | -| <a id="property-aria-current"></a> `aria-current?` | `boolean` \| `"true"` \| `"false"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` | Indicates the element that represents the current item within a container or set of related elements. | `Omit.aria-current` | me-client/node\_modules/@types/react/index.d.ts:2661 | -| <a id="property-aria-describedby"></a> `aria-describedby?` | `string` | Identifies the element (or elements) that describes the object. **See** aria-labelledby | `Omit.aria-describedby` | me-client/node\_modules/@types/react/index.d.ts:2666 | -| <a id="property-aria-description"></a> `aria-description?` | `string` | Defines a string value that describes or annotates the current element. **See** related aria-describedby. | `Omit.aria-description` | me-client/node\_modules/@types/react/index.d.ts:2671 | -| <a id="property-aria-details"></a> `aria-details?` | `string` | Identifies the element that provides a detailed, extended description for the object. **See** aria-describedby. | `Omit.aria-details` | me-client/node\_modules/@types/react/index.d.ts:2676 | -| <a id="property-aria-disabled"></a> `aria-disabled?` | `Booleanish` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. **See** - aria-hidden - aria-readonly. | `Omit.aria-disabled` | me-client/node\_modules/@types/react/index.d.ts:2681 | -| <a id="property-aria-dropeffect"></a> ~~`aria-dropeffect?`~~ | `"none"` \| `"link"` \| `"copy"` \| `"execute"` \| `"move"` \| `"popup"` | Indicates what functions can be performed when a dragged object is released on the drop target. **Deprecated** in ARIA 1.1 | `Omit.aria-dropeffect` | me-client/node\_modules/@types/react/index.d.ts:2686 | -| <a id="property-aria-errormessage"></a> `aria-errormessage?` | `string` | Identifies the element that provides an error message for the object. **See** - aria-invalid - aria-describedby. | `Omit.aria-errormessage` | me-client/node\_modules/@types/react/index.d.ts:2691 | -| <a id="property-aria-expanded"></a> `aria-expanded?` | `Booleanish` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | `Omit.aria-expanded` | me-client/node\_modules/@types/react/index.d.ts:2693 | -| <a id="property-aria-flowto"></a> `aria-flowto?` | `string` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | `Omit.aria-flowto` | me-client/node\_modules/@types/react/index.d.ts:2698 | -| <a id="property-aria-grabbed"></a> ~~`aria-grabbed?`~~ | `Booleanish` | Indicates an element's "grabbed" state in a drag-and-drop operation. **Deprecated** in ARIA 1.1 | `Omit.aria-grabbed` | me-client/node\_modules/@types/react/index.d.ts:2703 | -| <a id="property-aria-haspopup"></a> `aria-haspopup?` | \| `boolean` \| `"true"` \| `"false"` \| `"dialog"` \| `"grid"` \| `"listbox"` \| `"menu"` \| `"tree"` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | `Omit.aria-haspopup` | me-client/node\_modules/@types/react/index.d.ts:2705 | -| <a id="property-aria-hidden"></a> `aria-hidden?` | `Booleanish` | Indicates whether the element is exposed to an accessibility API. **See** aria-disabled. | `Omit.aria-hidden` | me-client/node\_modules/@types/react/index.d.ts:2710 | -| <a id="property-aria-invalid"></a> `aria-invalid?` | `boolean` \| `"true"` \| `"false"` \| `"grammar"` \| `"spelling"` | Indicates the entered value does not conform to the format expected by the application. **See** aria-errormessage. | `Omit.aria-invalid` | me-client/node\_modules/@types/react/index.d.ts:2715 | -| <a id="property-aria-keyshortcuts"></a> `aria-keyshortcuts?` | `string` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | `Omit.aria-keyshortcuts` | me-client/node\_modules/@types/react/index.d.ts:2717 | -| <a id="property-aria-label"></a> `aria-label?` | `string` | Defines a string value that labels the current element. **See** aria-labelledby. | `Omit.aria-label` | me-client/node\_modules/@types/react/index.d.ts:2722 | -| <a id="property-aria-labelledby"></a> `aria-labelledby?` | `string` | Identifies the element (or elements) that labels the current element. **See** aria-describedby. | `Omit.aria-labelledby` | me-client/node\_modules/@types/react/index.d.ts:2727 | -| <a id="property-aria-level"></a> `aria-level?` | `number` | Defines the hierarchical level of an element within a structure. | `Omit.aria-level` | me-client/node\_modules/@types/react/index.d.ts:2729 | -| <a id="property-aria-live"></a> `aria-live?` | `"off"` \| `"assertive"` \| `"polite"` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | `Omit.aria-live` | me-client/node\_modules/@types/react/index.d.ts:2731 | -| <a id="property-aria-modal"></a> `aria-modal?` | `Booleanish` | Indicates whether an element is modal when displayed. | `Omit.aria-modal` | me-client/node\_modules/@types/react/index.d.ts:2733 | -| <a id="property-aria-multiline"></a> `aria-multiline?` | `Booleanish` | Indicates whether a text box accepts multiple lines of input or only a single line. | `Omit.aria-multiline` | me-client/node\_modules/@types/react/index.d.ts:2735 | -| <a id="property-aria-multiselectable"></a> `aria-multiselectable?` | `Booleanish` | Indicates that the user may select more than one item from the current selectable descendants. | `Omit.aria-multiselectable` | me-client/node\_modules/@types/react/index.d.ts:2737 | -| <a id="property-aria-orientation"></a> `aria-orientation?` | `"horizontal"` \| `"vertical"` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | `Omit.aria-orientation` | me-client/node\_modules/@types/react/index.d.ts:2739 | -| <a id="property-aria-owns"></a> `aria-owns?` | `string` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. **See** aria-controls. | `Omit.aria-owns` | me-client/node\_modules/@types/react/index.d.ts:2745 | -| <a id="property-aria-placeholder"></a> `aria-placeholder?` | `string` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | `Omit.aria-placeholder` | me-client/node\_modules/@types/react/index.d.ts:2750 | -| <a id="property-aria-posinset"></a> `aria-posinset?` | `number` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. **See** aria-setsize. | `Omit.aria-posinset` | me-client/node\_modules/@types/react/index.d.ts:2755 | -| <a id="property-aria-pressed"></a> `aria-pressed?` | `boolean` \| `"true"` \| `"false"` \| `"mixed"` | Indicates the current "pressed" state of toggle buttons. **See** - aria-checked - aria-selected. | `Omit.aria-pressed` | me-client/node\_modules/@types/react/index.d.ts:2760 | -| <a id="property-aria-readonly"></a> `aria-readonly?` | `Booleanish` | Indicates that the element is not editable, but is otherwise operable. **See** aria-disabled. | `Omit.aria-readonly` | me-client/node\_modules/@types/react/index.d.ts:2765 | -| <a id="property-aria-relevant"></a> `aria-relevant?` | \| `"text"` \| `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text additions"` \| `"text removals"` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. **See** aria-atomic. | `Omit.aria-relevant` | me-client/node\_modules/@types/react/index.d.ts:2770 | -| <a id="property-aria-required"></a> `aria-required?` | `Booleanish` | Indicates that user input is required on the element before a form may be submitted. | `Omit.aria-required` | me-client/node\_modules/@types/react/index.d.ts:2783 | -| <a id="property-aria-roledescription"></a> `aria-roledescription?` | `string` | Defines a human-readable, author-localized description for the role of an element. | `Omit.aria-roledescription` | me-client/node\_modules/@types/react/index.d.ts:2785 | -| <a id="property-aria-rowcount"></a> `aria-rowcount?` | `number` | Defines the total number of rows in a table, grid, or treegrid. **See** aria-rowindex. | `Omit.aria-rowcount` | me-client/node\_modules/@types/react/index.d.ts:2790 | -| <a id="property-aria-rowindex"></a> `aria-rowindex?` | `number` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. **See** - aria-rowcount - aria-rowspan. | `Omit.aria-rowindex` | me-client/node\_modules/@types/react/index.d.ts:2795 | -| <a id="property-aria-rowindextext"></a> `aria-rowindextext?` | `string` | Defines a human readable text alternative of aria-rowindex. **See** aria-colindextext. | `Omit.aria-rowindextext` | me-client/node\_modules/@types/react/index.d.ts:2800 | -| <a id="property-aria-rowspan"></a> `aria-rowspan?` | `number` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. **See** - aria-rowindex - aria-colspan. | `Omit.aria-rowspan` | me-client/node\_modules/@types/react/index.d.ts:2805 | -| <a id="property-aria-selected"></a> `aria-selected?` | `Booleanish` | Indicates the current "selected" state of various widgets. **See** - aria-checked - aria-pressed. | `Omit.aria-selected` | me-client/node\_modules/@types/react/index.d.ts:2810 | -| <a id="property-aria-setsize"></a> `aria-setsize?` | `number` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. **See** aria-posinset. | `Omit.aria-setsize` | me-client/node\_modules/@types/react/index.d.ts:2815 | -| <a id="property-aria-sort"></a> `aria-sort?` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` | Indicates if items in a table or grid are sorted in ascending or descending order. | `Omit.aria-sort` | me-client/node\_modules/@types/react/index.d.ts:2817 | -| <a id="property-aria-valuemax"></a> `aria-valuemax?` | `number` | Defines the maximum allowed value for a range widget. | `Omit.aria-valuemax` | me-client/node\_modules/@types/react/index.d.ts:2819 | -| <a id="property-aria-valuemin"></a> `aria-valuemin?` | `number` | Defines the minimum allowed value for a range widget. | `Omit.aria-valuemin` | me-client/node\_modules/@types/react/index.d.ts:2821 | -| <a id="property-aria-valuenow"></a> `aria-valuenow?` | `number` | Defines the current value for a range widget. **See** aria-valuetext. | `Omit.aria-valuenow` | me-client/node\_modules/@types/react/index.d.ts:2826 | -| <a id="property-aria-valuetext"></a> `aria-valuetext?` | `string` | Defines the human readable text alternative of aria-valuenow for a range widget. | `Omit.aria-valuetext` | me-client/node\_modules/@types/react/index.d.ts:2828 | -| <a id="property-autocapitalize"></a> `autoCapitalize?` | \| `"off"` \| `"none"` \| `"on"` \| `"sentences"` \| `"words"` \| `"characters"` \| `string` & \{ \} | - | `Omit.autoCapitalize` | me-client/node\_modules/@types/react/index.d.ts:2913 | -| <a id="property-autocorrect"></a> `autoCorrect?` | `string` | - | `Omit.autoCorrect` | me-client/node\_modules/@types/react/index.d.ts:2952 | -| <a id="property-autofocus"></a> `autoFocus?` | `boolean` | - | `Omit.autoFocus` | me-client/node\_modules/@types/react/index.d.ts:2914 | -| <a id="property-autosave"></a> `autoSave?` | `string` | - | `Omit.autoSave` | me-client/node\_modules/@types/react/index.d.ts:2953 | -| <a id="property-children"></a> `children?` | `ReactNode` | - | `Omit.children` | me-client/node\_modules/@types/react/index.d.ts:2398 | -| <a id="property-classname"></a> `className?` | `string` | - | `Omit.className` | me-client/node\_modules/@types/react/index.d.ts:2915 | -| <a id="property-color"></a> `color?` | `string` | - | `Omit.color` | me-client/node\_modules/@types/react/index.d.ts:2954 | -| <a id="property-content"></a> `content?` | `string` | - | `Omit.content` | me-client/node\_modules/@types/react/index.d.ts:2940 | -| <a id="property-contenteditable"></a> `contentEditable?` | `Booleanish` \| `"inherit"` \| `"plaintext-only"` | - | `Omit.contentEditable` | me-client/node\_modules/@types/react/index.d.ts:2916 | -| <a id="property-contextmenu"></a> `contextMenu?` | `string` | - | `Omit.contextMenu` | me-client/node\_modules/@types/react/index.d.ts:2917 | -| <a id="property-dangerouslysetinnerhtml"></a> `dangerouslySetInnerHTML?` | \{ `__html`: `string` \| `TrustedHTML`; \} | - | `Omit.dangerouslySetInnerHTML` | me-client/node\_modules/@types/react/index.d.ts:2399 | -| `dangerouslySetInnerHTML.__html` | `string` \| `TrustedHTML` | - | - | me-client/node\_modules/@types/react/index.d.ts:2402 | -| <a id="property-datatype"></a> `datatype?` | `string` | - | `Omit.datatype` | me-client/node\_modules/@types/react/index.d.ts:2941 | -| <a id="property-defaultchecked"></a> `defaultChecked?` | `boolean` | - | `Omit.defaultChecked` | me-client/node\_modules/@types/react/index.d.ts:2906 | -| <a id="property-defaultvalue"></a> `defaultValue?` | `string` \| `number` \| readonly `string`[] | - | `Omit.defaultValue` | me-client/node\_modules/@types/react/index.d.ts:2907 | -| <a id="property-dir"></a> `dir?` | `string` | - | `Omit.dir` | me-client/node\_modules/@types/react/index.d.ts:2918 | -| <a id="property-disabled"></a> `disabled?` | `boolean` | - | `Omit.disabled` | me-client/node\_modules/@types/react/index.d.ts:3161 | -| <a id="property-draggable"></a> `draggable?` | `Booleanish` | - | `Omit.draggable` | me-client/node\_modules/@types/react/index.d.ts:2919 | -| <a id="property-enterkeyhint"></a> `enterKeyHint?` | `"enter"` \| `"done"` \| `"go"` \| `"next"` \| `"previous"` \| `"search"` \| `"send"` | - | `Omit.enterKeyHint` | me-client/node\_modules/@types/react/index.d.ts:2920 | -| <a id="property-exportparts"></a> `exportparts?` | `string` | **See** [https://developer.mozilla.org/en-US/docs/Web/HTML/Global\_attributes/exportparts](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts) | `Omit.exportparts` | me-client/node\_modules/@types/react/index.d.ts:2978 | -| <a id="property-form"></a> `form?` | `string` | - | `Omit.form` | me-client/node\_modules/@types/react/index.d.ts:3162 | -| <a id="property-formaction"></a> `formAction?` | `string` | - | `Omit.formAction` | me-client/node\_modules/@types/react/index.d.ts:3163 | -| <a id="property-formenctype"></a> `formEncType?` | `string` | - | `Omit.formEncType` | me-client/node\_modules/@types/react/index.d.ts:3169 | -| <a id="property-formmethod"></a> `formMethod?` | `string` | - | `Omit.formMethod` | me-client/node\_modules/@types/react/index.d.ts:3170 | -| <a id="property-formnovalidate"></a> `formNoValidate?` | `boolean` | - | `Omit.formNoValidate` | me-client/node\_modules/@types/react/index.d.ts:3171 | -| <a id="property-formtarget"></a> `formTarget?` | `string` | - | `Omit.formTarget` | me-client/node\_modules/@types/react/index.d.ts:3172 | -| <a id="property-hidden"></a> `hidden?` | `boolean` | - | `Omit.hidden` | me-client/node\_modules/@types/react/index.d.ts:2921 | -| <a id="property-id"></a> `id?` | `string` | - | `Omit.id` | me-client/node\_modules/@types/react/index.d.ts:2922 | -| <a id="property-inlist"></a> `inlist?` | `any` | - | `Omit.inlist` | me-client/node\_modules/@types/react/index.d.ts:2942 | -| <a id="property-inputmode"></a> `inputMode?` | \| `"email"` \| `"none"` \| `"search"` \| `"text"` \| `"tel"` \| `"url"` \| `"numeric"` \| `"decimal"` | Hints at the type of data that might be entered by the user while editing the element or its contents **See** [https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) | `Omit.inputMode` | me-client/node\_modules/@types/react/index.d.ts:2969 | -| <a id="property-is"></a> `is?` | `string` | Specify that a standard HTML element should behave like a defined custom built-in element **See** [https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) | `Omit.is` | me-client/node\_modules/@types/react/index.d.ts:2974 | -| <a id="property-itemid"></a> `itemID?` | `string` | - | `Omit.itemID` | me-client/node\_modules/@types/react/index.d.ts:2958 | -| <a id="property-itemprop"></a> `itemProp?` | `string` | - | `Omit.itemProp` | me-client/node\_modules/@types/react/index.d.ts:2955 | -| <a id="property-itemref"></a> `itemRef?` | `string` | - | `Omit.itemRef` | me-client/node\_modules/@types/react/index.d.ts:2959 | -| <a id="property-itemscope"></a> `itemScope?` | `boolean` | - | `Omit.itemScope` | me-client/node\_modules/@types/react/index.d.ts:2956 | -| <a id="property-itemtype"></a> `itemType?` | `string` | - | `Omit.itemType` | me-client/node\_modules/@types/react/index.d.ts:2957 | -| <a id="property-label"></a> `label?` | `string` | Custom button text. Defaults to "sign in with oc". | - | [me-client/src/SignInButton.tsx:16](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L16) | -| <a id="property-lang"></a> `lang?` | `string` | - | `Omit.lang` | me-client/node\_modules/@types/react/index.d.ts:2923 | -| <a id="property-name"></a> `name?` | `string` | - | `Omit.name` | me-client/node\_modules/@types/react/index.d.ts:3173 | -| <a id="property-nonce"></a> `nonce?` | `string` | - | `Omit.nonce` | me-client/node\_modules/@types/react/index.d.ts:2924 | -| <a id="property-onabort"></a> `onAbort?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAbort` | me-client/node\_modules/@types/react/index.d.ts:2458 | -| <a id="property-onabortcapture"></a> `onAbortCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAbortCapture` | me-client/node\_modules/@types/react/index.d.ts:2459 | -| <a id="property-onanimationend"></a> `onAnimationEnd?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationEnd` | me-client/node\_modules/@types/react/index.d.ts:2586 | -| <a id="property-onanimationendcapture"></a> `onAnimationEndCapture?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationEndCapture` | me-client/node\_modules/@types/react/index.d.ts:2587 | -| <a id="property-onanimationiteration"></a> `onAnimationIteration?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationIteration` | me-client/node\_modules/@types/react/index.d.ts:2588 | -| <a id="property-onanimationiterationcapture"></a> `onAnimationIterationCapture?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationIterationCapture` | me-client/node\_modules/@types/react/index.d.ts:2589 | -| <a id="property-onanimationstart"></a> `onAnimationStart?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationStart` | me-client/node\_modules/@types/react/index.d.ts:2584 | -| <a id="property-onanimationstartcapture"></a> `onAnimationStartCapture?` | `AnimationEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAnimationStartCapture` | me-client/node\_modules/@types/react/index.d.ts:2585 | -| <a id="property-onauxclick"></a> `onAuxClick?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAuxClick` | me-client/node\_modules/@types/react/index.d.ts:2504 | -| <a id="property-onauxclickcapture"></a> `onAuxClickCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onAuxClickCapture` | me-client/node\_modules/@types/react/index.d.ts:2505 | -| <a id="property-onbeforeinput"></a> `onBeforeInput?` | `InputEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onBeforeInput` | me-client/node\_modules/@types/react/index.d.ts:2430 | -| <a id="property-onbeforeinputcapture"></a> `onBeforeInputCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onBeforeInputCapture` | me-client/node\_modules/@types/react/index.d.ts:2431 | -| <a id="property-onblur"></a> `onBlur?` | `FocusEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onBlur` | me-client/node\_modules/@types/react/index.d.ts:2424 | -| <a id="property-onblurcapture"></a> `onBlurCapture?` | `FocusEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onBlurCapture` | me-client/node\_modules/@types/react/index.d.ts:2425 | -| <a id="property-oncanplay"></a> `onCanPlay?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCanPlay` | me-client/node\_modules/@types/react/index.d.ts:2460 | -| <a id="property-oncanplaycapture"></a> `onCanPlayCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCanPlayCapture` | me-client/node\_modules/@types/react/index.d.ts:2461 | -| <a id="property-oncanplaythrough"></a> `onCanPlayThrough?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCanPlayThrough` | me-client/node\_modules/@types/react/index.d.ts:2462 | -| <a id="property-oncanplaythroughcapture"></a> `onCanPlayThroughCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCanPlayThroughCapture` | me-client/node\_modules/@types/react/index.d.ts:2463 | -| <a id="property-onchange"></a> `onChange?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onChange` | me-client/node\_modules/@types/react/index.d.ts:2428 | -| <a id="property-onchangecapture"></a> `onChangeCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onChangeCapture` | me-client/node\_modules/@types/react/index.d.ts:2429 | -| <a id="property-onclick"></a> `onClick?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onClick` | me-client/node\_modules/@types/react/index.d.ts:2506 | -| <a id="property-onclickcapture"></a> `onClickCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onClickCapture` | me-client/node\_modules/@types/react/index.d.ts:2507 | -| <a id="property-oncompositionend"></a> `onCompositionEnd?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionEnd` | me-client/node\_modules/@types/react/index.d.ts:2414 | -| <a id="property-oncompositionendcapture"></a> `onCompositionEndCapture?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionEndCapture` | me-client/node\_modules/@types/react/index.d.ts:2415 | -| <a id="property-oncompositionstart"></a> `onCompositionStart?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionStart` | me-client/node\_modules/@types/react/index.d.ts:2416 | -| <a id="property-oncompositionstartcapture"></a> `onCompositionStartCapture?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionStartCapture` | me-client/node\_modules/@types/react/index.d.ts:2417 | -| <a id="property-oncompositionupdate"></a> `onCompositionUpdate?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionUpdate` | me-client/node\_modules/@types/react/index.d.ts:2418 | -| <a id="property-oncompositionupdatecapture"></a> `onCompositionUpdateCapture?` | `CompositionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCompositionUpdateCapture` | me-client/node\_modules/@types/react/index.d.ts:2419 | -| <a id="property-oncontextmenu"></a> `onContextMenu?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onContextMenu` | me-client/node\_modules/@types/react/index.d.ts:2508 | -| <a id="property-oncontextmenucapture"></a> `onContextMenuCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onContextMenuCapture` | me-client/node\_modules/@types/react/index.d.ts:2509 | -| <a id="property-oncopy"></a> `onCopy?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCopy` | me-client/node\_modules/@types/react/index.d.ts:2406 | -| <a id="property-oncopycapture"></a> `onCopyCapture?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCopyCapture` | me-client/node\_modules/@types/react/index.d.ts:2407 | -| <a id="property-oncut"></a> `onCut?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCut` | me-client/node\_modules/@types/react/index.d.ts:2408 | -| <a id="property-oncutcapture"></a> `onCutCapture?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onCutCapture` | me-client/node\_modules/@types/react/index.d.ts:2409 | -| <a id="property-ondoubleclick"></a> `onDoubleClick?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDoubleClick` | me-client/node\_modules/@types/react/index.d.ts:2510 | -| <a id="property-ondoubleclickcapture"></a> `onDoubleClickCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDoubleClickCapture` | me-client/node\_modules/@types/react/index.d.ts:2511 | -| <a id="property-ondrag"></a> `onDrag?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDrag` | me-client/node\_modules/@types/react/index.d.ts:2512 | -| <a id="property-ondragcapture"></a> `onDragCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragCapture` | me-client/node\_modules/@types/react/index.d.ts:2513 | -| <a id="property-ondragend"></a> `onDragEnd?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragEnd` | me-client/node\_modules/@types/react/index.d.ts:2514 | -| <a id="property-ondragendcapture"></a> `onDragEndCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragEndCapture` | me-client/node\_modules/@types/react/index.d.ts:2515 | -| <a id="property-ondragenter"></a> `onDragEnter?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragEnter` | me-client/node\_modules/@types/react/index.d.ts:2516 | -| <a id="property-ondragentercapture"></a> `onDragEnterCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragEnterCapture` | me-client/node\_modules/@types/react/index.d.ts:2517 | -| <a id="property-ondragexit"></a> `onDragExit?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragExit` | me-client/node\_modules/@types/react/index.d.ts:2518 | -| <a id="property-ondragexitcapture"></a> `onDragExitCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragExitCapture` | me-client/node\_modules/@types/react/index.d.ts:2519 | -| <a id="property-ondragleave"></a> `onDragLeave?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragLeave` | me-client/node\_modules/@types/react/index.d.ts:2520 | -| <a id="property-ondragleavecapture"></a> `onDragLeaveCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragLeaveCapture` | me-client/node\_modules/@types/react/index.d.ts:2521 | -| <a id="property-ondragover"></a> `onDragOver?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragOver` | me-client/node\_modules/@types/react/index.d.ts:2522 | -| <a id="property-ondragovercapture"></a> `onDragOverCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragOverCapture` | me-client/node\_modules/@types/react/index.d.ts:2523 | -| <a id="property-ondragstart"></a> `onDragStart?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragStart` | me-client/node\_modules/@types/react/index.d.ts:2524 | -| <a id="property-ondragstartcapture"></a> `onDragStartCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDragStartCapture` | me-client/node\_modules/@types/react/index.d.ts:2525 | -| <a id="property-ondrop"></a> `onDrop?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDrop` | me-client/node\_modules/@types/react/index.d.ts:2526 | -| <a id="property-ondropcapture"></a> `onDropCapture?` | `DragEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDropCapture` | me-client/node\_modules/@types/react/index.d.ts:2527 | -| <a id="property-ondurationchange"></a> `onDurationChange?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDurationChange` | me-client/node\_modules/@types/react/index.d.ts:2464 | -| <a id="property-ondurationchangecapture"></a> `onDurationChangeCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onDurationChangeCapture` | me-client/node\_modules/@types/react/index.d.ts:2465 | -| <a id="property-onemptied"></a> `onEmptied?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEmptied` | me-client/node\_modules/@types/react/index.d.ts:2466 | -| <a id="property-onemptiedcapture"></a> `onEmptiedCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEmptiedCapture` | me-client/node\_modules/@types/react/index.d.ts:2467 | -| <a id="property-onencrypted"></a> `onEncrypted?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEncrypted` | me-client/node\_modules/@types/react/index.d.ts:2468 | -| <a id="property-onencryptedcapture"></a> `onEncryptedCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEncryptedCapture` | me-client/node\_modules/@types/react/index.d.ts:2469 | -| <a id="property-onended"></a> `onEnded?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEnded` | me-client/node\_modules/@types/react/index.d.ts:2470 | -| <a id="property-onendedcapture"></a> `onEndedCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onEndedCapture` | me-client/node\_modules/@types/react/index.d.ts:2471 | -| <a id="property-onerrorcapture"></a> `onErrorCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onErrorCapture` | me-client/node\_modules/@types/react/index.d.ts:2445 | -| <a id="property-onfocus"></a> `onFocus?` | `FocusEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onFocus` | me-client/node\_modules/@types/react/index.d.ts:2422 | -| <a id="property-onfocuscapture"></a> `onFocusCapture?` | `FocusEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onFocusCapture` | me-client/node\_modules/@types/react/index.d.ts:2423 | -| <a id="property-ongotpointercapture"></a> `onGotPointerCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onGotPointerCapture` | me-client/node\_modules/@types/react/index.d.ts:2570 | -| <a id="property-ongotpointercapturecapture"></a> `onGotPointerCaptureCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onGotPointerCaptureCapture` | me-client/node\_modules/@types/react/index.d.ts:2571 | -| <a id="property-oninput"></a> `onInput?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onInput` | me-client/node\_modules/@types/react/index.d.ts:2432 | -| <a id="property-oninputcapture"></a> `onInputCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onInputCapture` | me-client/node\_modules/@types/react/index.d.ts:2433 | -| <a id="property-oninvalid"></a> `onInvalid?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onInvalid` | me-client/node\_modules/@types/react/index.d.ts:2438 | -| <a id="property-oninvalidcapture"></a> `onInvalidCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onInvalidCapture` | me-client/node\_modules/@types/react/index.d.ts:2439 | -| <a id="property-onkeydown"></a> `onKeyDown?` | `KeyboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onKeyDown` | me-client/node\_modules/@types/react/index.d.ts:2448 | -| <a id="property-onkeydowncapture"></a> `onKeyDownCapture?` | `KeyboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onKeyDownCapture` | me-client/node\_modules/@types/react/index.d.ts:2449 | -| <a id="property-onkeypress"></a> ~~`onKeyPress?`~~ | `KeyboardEventHandler`\<`HTMLButtonElement`\> | **Deprecated** Use `onKeyUp` or `onKeyDown` instead | `Omit.onKeyPress` | me-client/node\_modules/@types/react/index.d.ts:2451 | -| <a id="property-onkeypresscapture"></a> ~~`onKeyPressCapture?`~~ | `KeyboardEventHandler`\<`HTMLButtonElement`\> | **Deprecated** Use `onKeyUpCapture` or `onKeyDownCapture` instead | `Omit.onKeyPressCapture` | me-client/node\_modules/@types/react/index.d.ts:2453 | -| <a id="property-onkeyup"></a> `onKeyUp?` | `KeyboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onKeyUp` | me-client/node\_modules/@types/react/index.d.ts:2454 | -| <a id="property-onkeyupcapture"></a> `onKeyUpCapture?` | `KeyboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onKeyUpCapture` | me-client/node\_modules/@types/react/index.d.ts:2455 | -| <a id="property-onload"></a> `onLoad?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoad` | me-client/node\_modules/@types/react/index.d.ts:2442 | -| <a id="property-onloadcapture"></a> `onLoadCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadCapture` | me-client/node\_modules/@types/react/index.d.ts:2443 | -| <a id="property-onloadeddata"></a> `onLoadedData?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadedData` | me-client/node\_modules/@types/react/index.d.ts:2472 | -| <a id="property-onloadeddatacapture"></a> `onLoadedDataCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadedDataCapture` | me-client/node\_modules/@types/react/index.d.ts:2473 | -| <a id="property-onloadedmetadata"></a> `onLoadedMetadata?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadedMetadata` | me-client/node\_modules/@types/react/index.d.ts:2474 | -| <a id="property-onloadedmetadatacapture"></a> `onLoadedMetadataCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadedMetadataCapture` | me-client/node\_modules/@types/react/index.d.ts:2475 | -| <a id="property-onloadstart"></a> `onLoadStart?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadStart` | me-client/node\_modules/@types/react/index.d.ts:2476 | -| <a id="property-onloadstartcapture"></a> `onLoadStartCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLoadStartCapture` | me-client/node\_modules/@types/react/index.d.ts:2477 | -| <a id="property-onlostpointercapture"></a> `onLostPointerCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLostPointerCapture` | me-client/node\_modules/@types/react/index.d.ts:2572 | -| <a id="property-onlostpointercapturecapture"></a> `onLostPointerCaptureCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onLostPointerCaptureCapture` | me-client/node\_modules/@types/react/index.d.ts:2573 | -| <a id="property-onmousedown"></a> `onMouseDown?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseDown` | me-client/node\_modules/@types/react/index.d.ts:2528 | -| <a id="property-onmousedowncapture"></a> `onMouseDownCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseDownCapture` | me-client/node\_modules/@types/react/index.d.ts:2529 | -| <a id="property-onmouseenter"></a> `onMouseEnter?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseEnter` | me-client/node\_modules/@types/react/index.d.ts:2530 | -| <a id="property-onmouseleave"></a> `onMouseLeave?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseLeave` | me-client/node\_modules/@types/react/index.d.ts:2531 | -| <a id="property-onmousemove"></a> `onMouseMove?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseMove` | me-client/node\_modules/@types/react/index.d.ts:2532 | -| <a id="property-onmousemovecapture"></a> `onMouseMoveCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseMoveCapture` | me-client/node\_modules/@types/react/index.d.ts:2533 | -| <a id="property-onmouseout"></a> `onMouseOut?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseOut` | me-client/node\_modules/@types/react/index.d.ts:2534 | -| <a id="property-onmouseoutcapture"></a> `onMouseOutCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseOutCapture` | me-client/node\_modules/@types/react/index.d.ts:2535 | -| <a id="property-onmouseover"></a> `onMouseOver?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseOver` | me-client/node\_modules/@types/react/index.d.ts:2536 | -| <a id="property-onmouseovercapture"></a> `onMouseOverCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseOverCapture` | me-client/node\_modules/@types/react/index.d.ts:2537 | -| <a id="property-onmouseup"></a> `onMouseUp?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseUp` | me-client/node\_modules/@types/react/index.d.ts:2538 | -| <a id="property-onmouseupcapture"></a> `onMouseUpCapture?` | `MouseEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onMouseUpCapture` | me-client/node\_modules/@types/react/index.d.ts:2539 | -| <a id="property-onpaste"></a> `onPaste?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPaste` | me-client/node\_modules/@types/react/index.d.ts:2410 | -| <a id="property-onpastecapture"></a> `onPasteCapture?` | `ClipboardEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPasteCapture` | me-client/node\_modules/@types/react/index.d.ts:2411 | -| <a id="property-onpause"></a> `onPause?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPause` | me-client/node\_modules/@types/react/index.d.ts:2478 | -| <a id="property-onpausecapture"></a> `onPauseCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPauseCapture` | me-client/node\_modules/@types/react/index.d.ts:2479 | -| <a id="property-onplay"></a> `onPlay?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPlay` | me-client/node\_modules/@types/react/index.d.ts:2480 | -| <a id="property-onplaycapture"></a> `onPlayCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPlayCapture` | me-client/node\_modules/@types/react/index.d.ts:2481 | -| <a id="property-onplaying"></a> `onPlaying?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPlaying` | me-client/node\_modules/@types/react/index.d.ts:2482 | -| <a id="property-onplayingcapture"></a> `onPlayingCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPlayingCapture` | me-client/node\_modules/@types/react/index.d.ts:2483 | -| <a id="property-onpointercancel"></a> `onPointerCancel?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerCancel` | me-client/node\_modules/@types/react/index.d.ts:2562 | -| <a id="property-onpointercancelcapture"></a> `onPointerCancelCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerCancelCapture` | me-client/node\_modules/@types/react/index.d.ts:2563 | -| <a id="property-onpointerdown"></a> `onPointerDown?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerDown` | me-client/node\_modules/@types/react/index.d.ts:2556 | -| <a id="property-onpointerdowncapture"></a> `onPointerDownCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerDownCapture` | me-client/node\_modules/@types/react/index.d.ts:2557 | -| <a id="property-onpointerenter"></a> `onPointerEnter?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerEnter` | me-client/node\_modules/@types/react/index.d.ts:2564 | -| <a id="property-onpointerleave"></a> `onPointerLeave?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerLeave` | me-client/node\_modules/@types/react/index.d.ts:2565 | -| <a id="property-onpointermove"></a> `onPointerMove?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerMove` | me-client/node\_modules/@types/react/index.d.ts:2558 | -| <a id="property-onpointermovecapture"></a> `onPointerMoveCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerMoveCapture` | me-client/node\_modules/@types/react/index.d.ts:2559 | -| <a id="property-onpointerout"></a> `onPointerOut?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerOut` | me-client/node\_modules/@types/react/index.d.ts:2568 | -| <a id="property-onpointeroutcapture"></a> `onPointerOutCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerOutCapture` | me-client/node\_modules/@types/react/index.d.ts:2569 | -| <a id="property-onpointerover"></a> `onPointerOver?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerOver` | me-client/node\_modules/@types/react/index.d.ts:2566 | -| <a id="property-onpointerovercapture"></a> `onPointerOverCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerOverCapture` | me-client/node\_modules/@types/react/index.d.ts:2567 | -| <a id="property-onpointerup"></a> `onPointerUp?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerUp` | me-client/node\_modules/@types/react/index.d.ts:2560 | -| <a id="property-onpointerupcapture"></a> `onPointerUpCapture?` | `PointerEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onPointerUpCapture` | me-client/node\_modules/@types/react/index.d.ts:2561 | -| <a id="property-onprogress"></a> `onProgress?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onProgress` | me-client/node\_modules/@types/react/index.d.ts:2484 | -| <a id="property-onprogresscapture"></a> `onProgressCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onProgressCapture` | me-client/node\_modules/@types/react/index.d.ts:2485 | -| <a id="property-onratechange"></a> `onRateChange?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onRateChange` | me-client/node\_modules/@types/react/index.d.ts:2486 | -| <a id="property-onratechangecapture"></a> `onRateChangeCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onRateChangeCapture` | me-client/node\_modules/@types/react/index.d.ts:2487 | -| <a id="property-onreset"></a> `onReset?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onReset` | me-client/node\_modules/@types/react/index.d.ts:2434 | -| <a id="property-onresetcapture"></a> `onResetCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onResetCapture` | me-client/node\_modules/@types/react/index.d.ts:2435 | -| <a id="property-onscroll"></a> `onScroll?` | `UIEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onScroll` | me-client/node\_modules/@types/react/index.d.ts:2576 | -| <a id="property-onscrollcapture"></a> `onScrollCapture?` | `UIEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onScrollCapture` | me-client/node\_modules/@types/react/index.d.ts:2577 | -| <a id="property-onseeked"></a> `onSeeked?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSeeked` | me-client/node\_modules/@types/react/index.d.ts:2488 | -| <a id="property-onseekedcapture"></a> `onSeekedCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSeekedCapture` | me-client/node\_modules/@types/react/index.d.ts:2489 | -| <a id="property-onseeking"></a> `onSeeking?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSeeking` | me-client/node\_modules/@types/react/index.d.ts:2490 | -| <a id="property-onseekingcapture"></a> `onSeekingCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSeekingCapture` | me-client/node\_modules/@types/react/index.d.ts:2491 | -| <a id="property-onselect"></a> `onSelect?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSelect` | me-client/node\_modules/@types/react/index.d.ts:2542 | -| <a id="property-onselectcapture"></a> `onSelectCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSelectCapture` | me-client/node\_modules/@types/react/index.d.ts:2543 | -| <a id="property-onsignin"></a> `onSignin?` | (`session`: [`Session`](Session.mdx)) => `void` | - | - | [me-client/src/SignInButton.tsx:11](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L11) | -| <a id="property-onsigninerror"></a> `onSignInError?` | (`error`: `Error`) => `void` | Called when the sign-in flow fails. Renamed from `onError` to avoid shadowing the native button error handler. | - | [me-client/src/SignInButton.tsx:14](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L14) | -| <a id="property-onstalled"></a> `onStalled?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onStalled` | me-client/node\_modules/@types/react/index.d.ts:2492 | -| <a id="property-onstalledcapture"></a> `onStalledCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onStalledCapture` | me-client/node\_modules/@types/react/index.d.ts:2493 | -| <a id="property-onsubmit"></a> `onSubmit?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSubmit` | me-client/node\_modules/@types/react/index.d.ts:2436 | -| <a id="property-onsubmitcapture"></a> `onSubmitCapture?` | `FormEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSubmitCapture` | me-client/node\_modules/@types/react/index.d.ts:2437 | -| <a id="property-onsuspend"></a> `onSuspend?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSuspend` | me-client/node\_modules/@types/react/index.d.ts:2494 | -| <a id="property-onsuspendcapture"></a> `onSuspendCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onSuspendCapture` | me-client/node\_modules/@types/react/index.d.ts:2495 | -| <a id="property-ontimeupdate"></a> `onTimeUpdate?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTimeUpdate` | me-client/node\_modules/@types/react/index.d.ts:2496 | -| <a id="property-ontimeupdatecapture"></a> `onTimeUpdateCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTimeUpdateCapture` | me-client/node\_modules/@types/react/index.d.ts:2497 | -| <a id="property-ontouchcancel"></a> `onTouchCancel?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchCancel` | me-client/node\_modules/@types/react/index.d.ts:2546 | -| <a id="property-ontouchcancelcapture"></a> `onTouchCancelCapture?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchCancelCapture` | me-client/node\_modules/@types/react/index.d.ts:2547 | -| <a id="property-ontouchend"></a> `onTouchEnd?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchEnd` | me-client/node\_modules/@types/react/index.d.ts:2548 | -| <a id="property-ontouchendcapture"></a> `onTouchEndCapture?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchEndCapture` | me-client/node\_modules/@types/react/index.d.ts:2549 | -| <a id="property-ontouchmove"></a> `onTouchMove?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchMove` | me-client/node\_modules/@types/react/index.d.ts:2550 | -| <a id="property-ontouchmovecapture"></a> `onTouchMoveCapture?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchMoveCapture` | me-client/node\_modules/@types/react/index.d.ts:2551 | -| <a id="property-ontouchstart"></a> `onTouchStart?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchStart` | me-client/node\_modules/@types/react/index.d.ts:2552 | -| <a id="property-ontouchstartcapture"></a> `onTouchStartCapture?` | `TouchEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTouchStartCapture` | me-client/node\_modules/@types/react/index.d.ts:2553 | -| <a id="property-ontransitionend"></a> `onTransitionEnd?` | `TransitionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTransitionEnd` | me-client/node\_modules/@types/react/index.d.ts:2592 | -| <a id="property-ontransitionendcapture"></a> `onTransitionEndCapture?` | `TransitionEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onTransitionEndCapture` | me-client/node\_modules/@types/react/index.d.ts:2593 | -| <a id="property-onvolumechange"></a> `onVolumeChange?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onVolumeChange` | me-client/node\_modules/@types/react/index.d.ts:2498 | -| <a id="property-onvolumechangecapture"></a> `onVolumeChangeCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onVolumeChangeCapture` | me-client/node\_modules/@types/react/index.d.ts:2499 | -| <a id="property-onwaiting"></a> `onWaiting?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onWaiting` | me-client/node\_modules/@types/react/index.d.ts:2500 | -| <a id="property-onwaitingcapture"></a> `onWaitingCapture?` | `ReactEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onWaitingCapture` | me-client/node\_modules/@types/react/index.d.ts:2501 | -| <a id="property-onwheel"></a> `onWheel?` | `WheelEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onWheel` | me-client/node\_modules/@types/react/index.d.ts:2580 | -| <a id="property-onwheelcapture"></a> `onWheelCapture?` | `WheelEventHandler`\<`HTMLButtonElement`\> | - | `Omit.onWheelCapture` | me-client/node\_modules/@types/react/index.d.ts:2581 | -| <a id="property-part"></a> `part?` | `string` | **See** [https://developer.mozilla.org/en-US/docs/Web/HTML/Global\_attributes/part](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part) | `Omit.part` | me-client/node\_modules/@types/react/index.d.ts:2982 | -| <a id="property-prefix"></a> `prefix?` | `string` | - | `Omit.prefix` | me-client/node\_modules/@types/react/index.d.ts:2943 | -| <a id="property-property"></a> `property?` | `string` | - | `Omit.property` | me-client/node\_modules/@types/react/index.d.ts:2944 | -| <a id="property-radiogroup"></a> `radioGroup?` | `string` | - | `Omit.radioGroup` | me-client/node\_modules/@types/react/index.d.ts:2933 | -| <a id="property-rel"></a> `rel?` | `string` | - | `Omit.rel` | me-client/node\_modules/@types/react/index.d.ts:2945 | -| <a id="property-resource"></a> `resource?` | `string` | - | `Omit.resource` | me-client/node\_modules/@types/react/index.d.ts:2946 | -| <a id="property-results"></a> `results?` | `number` | - | `Omit.results` | me-client/node\_modules/@types/react/index.d.ts:2960 | -| <a id="property-returnto"></a> `returnTo?` | `string` | - | - | [me-client/src/SignInButton.tsx:10](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L10) | -| <a id="property-rev"></a> `rev?` | `string` | - | `Omit.rev` | me-client/node\_modules/@types/react/index.d.ts:2947 | -| <a id="property-role"></a> `role?` | `AriaRole` | - | `Omit.role` | me-client/node\_modules/@types/react/index.d.ts:2936 | -| <a id="property-scope"></a> `scope` | `string`[] | - | - | [me-client/src/SignInButton.tsx:8](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L8) | -| <a id="property-security"></a> `security?` | `string` | - | `Omit.security` | me-client/node\_modules/@types/react/index.d.ts:2961 | -| <a id="property-sessionpolicy"></a> `sessionPolicy?` | `Partial`\<[`SessionPolicy`](SessionPolicy.mdx)\> | - | - | [me-client/src/SignInButton.tsx:9](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L9) | -| <a id="property-slot"></a> `slot?` | `string` | - | `Omit.slot` | me-client/node\_modules/@types/react/index.d.ts:2925 | -| <a id="property-spellcheck"></a> `spellCheck?` | `Booleanish` | - | `Omit.spellCheck` | me-client/node\_modules/@types/react/index.d.ts:2926 | -| <a id="property-style"></a> `style?` | `CSSProperties` | - | `Omit.style` | me-client/node\_modules/@types/react/index.d.ts:2927 | -| <a id="property-suppresscontenteditablewarning"></a> `suppressContentEditableWarning?` | `boolean` | - | `Omit.suppressContentEditableWarning` | me-client/node\_modules/@types/react/index.d.ts:2908 | -| <a id="property-suppresshydrationwarning"></a> `suppressHydrationWarning?` | `boolean` | - | `Omit.suppressHydrationWarning` | me-client/node\_modules/@types/react/index.d.ts:2909 | -| <a id="property-tabindex"></a> `tabIndex?` | `number` | - | `Omit.tabIndex` | me-client/node\_modules/@types/react/index.d.ts:2928 | -| <a id="property-title"></a> `title?` | `string` | - | `Omit.title` | me-client/node\_modules/@types/react/index.d.ts:2929 | -| <a id="property-translate"></a> `translate?` | `"yes"` \| `"no"` | - | `Omit.translate` | me-client/node\_modules/@types/react/index.d.ts:2930 | -| <a id="property-type"></a> `type?` | `"submit"` \| `"reset"` \| `"button"` | - | `Omit.type` | me-client/node\_modules/@types/react/index.d.ts:3174 | -| <a id="property-typeof"></a> `typeof?` | `string` | - | `Omit.typeof` | me-client/node\_modules/@types/react/index.d.ts:2948 | -| <a id="property-unselectable"></a> `unselectable?` | `"off"` \| `"on"` | - | `Omit.unselectable` | me-client/node\_modules/@types/react/index.d.ts:2962 | -| <a id="property-value"></a> `value?` | `string` \| `number` \| readonly `string`[] | - | `Omit.value` | me-client/node\_modules/@types/react/index.d.ts:3175 | -| <a id="property-vocab"></a> `vocab?` | `string` | - | `Omit.vocab` | me-client/node\_modules/@types/react/index.d.ts:2949 | +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-label"></a> `label?` | `string` | Custom button text. Defaults to "sign in with oc". | [me-client/src/SignInButton.tsx:16](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L16) | +| <a id="property-onsignin"></a> `onSignin?` | (`session`: [`Session`](Session.mdx)) => `void` | - | [me-client/src/SignInButton.tsx:11](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L11) | +| <a id="property-onsigninerror"></a> `onSignInError?` | (`error`: `Error`) => `void` | Called when the sign-in flow fails. Renamed from `onError` to avoid shadowing the native button error handler. | [me-client/src/SignInButton.tsx:14](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L14) | +| <a id="property-returnto"></a> `returnTo?` | `string` | - | [me-client/src/SignInButton.tsx:10](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L10) | +| <a id="property-scope"></a> `scope` | `string`[] | - | [me-client/src/SignInButton.tsx:8](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L8) | +| <a id="property-sessionpolicy"></a> `sessionPolicy?` | `Partial`\<[`SessionPolicy`](SessionPolicy.mdx)\> | - | [me-client/src/SignInButton.tsx:9](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/SignInButton.tsx#L9) | diff --git a/src/pages/sdk/me-client/interfaces/PaymentAuthorizeOptions.mdx b/src/pages/sdk/me-client/interfaces/PaymentAuthorizeOptions.mdx index e8d2074..71df18e 100644 --- a/src/pages/sdk/me-client/interfaces/PaymentAuthorizeOptions.mdx +++ b/src/pages/sdk/me-client/interfaces/PaymentAuthorizeOptions.mdx @@ -11,14 +11,14 @@ export const metadata = { # Interface: PaymentAuthorizeOptions -Defined in: [me-client/src/types.ts:226](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L226) +Defined in: [me-client/src/types.ts:321](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L321) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-amount_sats"></a> `amount_sats?` | `number` | [me-client/src/types.ts:228](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L228) | -| <a id="property-description"></a> `description` | `string` | [me-client/src/types.ts:230](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L230) | -| <a id="property-external_ref"></a> `external_ref?` | `string` | [me-client/src/types.ts:231](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L231) | -| <a id="property-identity"></a> `identity` | `string` | [me-client/src/types.ts:227](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L227) | -| <a id="property-usd_cents"></a> `usd_cents?` | `number` | [me-client/src/types.ts:229](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L229) | +| <a id="property-amount_sats"></a> `amount_sats?` | `number` | [me-client/src/types.ts:323](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L323) | +| <a id="property-description"></a> `description` | `string` | [me-client/src/types.ts:325](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L325) | +| <a id="property-external_ref"></a> `external_ref?` | `string` | [me-client/src/types.ts:326](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L326) | +| <a id="property-identity"></a> `identity` | `string` | [me-client/src/types.ts:322](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L322) | +| <a id="property-usd_cents"></a> `usd_cents?` | `number` | [me-client/src/types.ts:324](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L324) | diff --git a/src/pages/sdk/me-client/interfaces/PaymentResult.mdx b/src/pages/sdk/me-client/interfaces/PaymentResult.mdx index 6b09246..f29a47b 100644 --- a/src/pages/sdk/me-client/interfaces/PaymentResult.mdx +++ b/src/pages/sdk/me-client/interfaces/PaymentResult.mdx @@ -11,14 +11,14 @@ export const metadata = { # Interface: PaymentResult -Defined in: [me-client/src/types.ts:234](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L234) +Defined in: [me-client/src/types.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L329) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-id"></a> `id` | `string` | [me-client/src/types.ts:235](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L235) | -| <a id="property-sats_charged"></a> `sats_charged?` | `number` | [me-client/src/types.ts:237](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L237) | -| <a id="property-status"></a> `status` | `"authorized"` \| `"failed"` \| `"cancelled"` | [me-client/src/types.ts:236](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L236) | -| <a id="property-user_envelope_id"></a> `user_envelope_id?` | `string` | [me-client/src/types.ts:238](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L238) | -| <a id="property-verify_url"></a> `verify_url?` | `string` | [me-client/src/types.ts:239](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L239) | +| <a id="property-id"></a> `id` | `string` | [me-client/src/types.ts:330](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L330) | +| <a id="property-sats_charged"></a> `sats_charged?` | `number` | [me-client/src/types.ts:332](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L332) | +| <a id="property-status"></a> `status` | `"authorized"` \| `"failed"` \| `"cancelled"` | [me-client/src/types.ts:331](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L331) | +| <a id="property-user_envelope_id"></a> `user_envelope_id?` | `string` | [me-client/src/types.ts:333](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L333) | +| <a id="property-verify_url"></a> `verify_url?` | `string` | [me-client/src/types.ts:334](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L334) | diff --git a/src/pages/sdk/me-client/interfaces/RequestOptions.mdx b/src/pages/sdk/me-client/interfaces/RequestOptions.mdx index 61ed352..492f025 100644 --- a/src/pages/sdk/me-client/interfaces/RequestOptions.mdx +++ b/src/pages/sdk/me-client/interfaces/RequestOptions.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: RequestOptions -Defined in: [me-client/src/scope.ts:82](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L82) +Defined in: [me-client/src/scope.ts:131](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L131) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-origin"></a> `origin?` | `string` | Override the OC origin (only useful for staging deployments; defaults to https://me.ochk.io via getOrigin()). | [me-client/src/scope.ts:91](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L91) | -| <a id="property-project_key"></a> `project_key` | `string` | Your project_key. Required. | [me-client/src/scope.ts:84](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L84) | -| <a id="property-return_to"></a> `return_to` | `string` | Where to bounce the user after they decide. Required. Same-origin only — me.ochk.io rejects cross-origin redirects to prevent the consent prompt from being weaponized in phishing. | [me-client/src/scope.ts:88](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L88) | +| <a id="property-origin"></a> `origin?` | `string` | Override the OC origin (only useful for staging deployments; defaults to https://me.ochk.io via getOrigin()). | [me-client/src/scope.ts:140](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L140) | +| <a id="property-project_key"></a> `project_key` | `string` | Your project_key. Required. | [me-client/src/scope.ts:133](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L133) | +| <a id="property-return_to"></a> `return_to` | `string` | Where to bounce the user after they decide. Required. Same-origin only — me.ochk.io rejects cross-origin redirects to prevent the consent prompt from being weaponized in phishing. | [me-client/src/scope.ts:137](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L137) | diff --git a/src/pages/sdk/me-client/interfaces/Session.mdx b/src/pages/sdk/me-client/interfaces/Session.mdx index 15f4524..f458e05 100644 --- a/src/pages/sdk/me-client/interfaces/Session.mdx +++ b/src/pages/sdk/me-client/interfaces/Session.mdx @@ -11,15 +11,15 @@ export const metadata = { # Interface: Session -Defined in: [me-client/src/types.ts:211](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L211) +Defined in: [me-client/src/types.ts:306](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L306) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-expires_at"></a> `expires_at` | `string` | [me-client/src/types.ts:215](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L215) | -| <a id="property-id"></a> `id` | `string` | [me-client/src/types.ts:212](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L212) | -| <a id="property-identity"></a> `identity` | `string` | [me-client/src/types.ts:213](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L213) | -| <a id="property-opens_at"></a> `opens_at` | `string` | [me-client/src/types.ts:214](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L214) | -| <a id="property-policy"></a> `policy` | [`SessionPolicy`](SessionPolicy.mdx) | [me-client/src/types.ts:216](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L216) | -| <a id="property-scope"></a> `scope` | `string`[] | [me-client/src/types.ts:217](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L217) | +| <a id="property-expires_at"></a> `expires_at` | `string` | [me-client/src/types.ts:310](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L310) | +| <a id="property-id"></a> `id` | `string` | [me-client/src/types.ts:307](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L307) | +| <a id="property-identity"></a> `identity` | `string` | [me-client/src/types.ts:308](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L308) | +| <a id="property-opens_at"></a> `opens_at` | `string` | [me-client/src/types.ts:309](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L309) | +| <a id="property-policy"></a> `policy` | [`SessionPolicy`](SessionPolicy.mdx) | [me-client/src/types.ts:311](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L311) | +| <a id="property-scope"></a> `scope` | `string`[] | [me-client/src/types.ts:312](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L312) | diff --git a/src/pages/sdk/me-client/interfaces/SessionPolicy.mdx b/src/pages/sdk/me-client/interfaces/SessionPolicy.mdx index 4e98e34..c94b80c 100644 --- a/src/pages/sdk/me-client/interfaces/SessionPolicy.mdx +++ b/src/pages/sdk/me-client/interfaces/SessionPolicy.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: SessionPolicy -Defined in: [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) +Defined in: [me-client/src/types.ts:300](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L300) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-duration_seconds"></a> `duration_seconds` | `number` | [me-client/src/types.ts:206](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L206) | -| <a id="property-refresh"></a> `refresh` | `"none"` \| `"sliding"` \| `"rolling"` | [me-client/src/types.ts:207](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L207) | -| <a id="property-sensitive_actions"></a> `sensitive_actions?` | `"none"` \| `"re-auth"` | [me-client/src/types.ts:208](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L208) | +| <a id="property-duration_seconds"></a> `duration_seconds` | `number` | [me-client/src/types.ts:301](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L301) | +| <a id="property-refresh"></a> `refresh` | `"sliding"` \| `"rolling"` \| `"none"` | [me-client/src/types.ts:302](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L302) | +| <a id="property-sensitive_actions"></a> `sensitive_actions?` | `"none"` \| `"re-auth"` | [me-client/src/types.ts:303](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L303) | diff --git a/src/pages/sdk/me-client/interfaces/SignInOptions.mdx b/src/pages/sdk/me-client/interfaces/SignInOptions.mdx index e897f5a..481d7d2 100644 --- a/src/pages/sdk/me-client/interfaces/SignInOptions.mdx +++ b/src/pages/sdk/me-client/interfaces/SignInOptions.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: SignInOptions -Defined in: [me-client/src/types.ts:220](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L220) +Defined in: [me-client/src/types.ts:315](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L315) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-returnto"></a> `returnTo?` | `string` | [me-client/src/types.ts:223](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L223) | -| <a id="property-scope"></a> `scope` | `string`[] | [me-client/src/types.ts:221](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L221) | -| <a id="property-sessionpolicy"></a> `sessionPolicy?` | `Partial`\<[`SessionPolicy`](SessionPolicy.mdx)\> | [me-client/src/types.ts:222](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L222) | +| <a id="property-returnto"></a> `returnTo?` | `string` | [me-client/src/types.ts:318](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L318) | +| <a id="property-scope"></a> `scope` | `string`[] | [me-client/src/types.ts:316](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L316) | +| <a id="property-sessionpolicy"></a> `sessionPolicy?` | `Partial`\<[`SessionPolicy`](SessionPolicy.mdx)\> | [me-client/src/types.ts:317](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L317) | diff --git a/src/pages/sdk/me-client/interfaces/TelemetryEvent.mdx b/src/pages/sdk/me-client/interfaces/TelemetryEvent.mdx index d15d06b..ab5b99a 100644 --- a/src/pages/sdk/me-client/interfaces/TelemetryEvent.mdx +++ b/src/pages/sdk/me-client/interfaces/TelemetryEvent.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: TelemetryEvent -Defined in: [me-client/src/types.ts:242](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L242) +Defined in: [me-client/src/types.ts:337](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L337) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-code"></a> `code` | \| `"session.intra_signin"` \| `"session.token_refresh"` \| `"session.navigation"` \| `"auth.signin_failed"` \| `"auth.signin_cancelled"` \| `"auth.signin_rejected"` \| `"verify.passive_check"` | [me-client/src/types.ts:243](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L243) | -| <a id="property-session_id"></a> `session_id?` | `string` | [me-client/src/types.ts:252](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L252) | -| <a id="property-timestamp"></a> `timestamp` | `string` | [me-client/src/types.ts:251](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L251) | +| <a id="property-code"></a> `code` | \| `"session.intra_signin"` \| `"session.token_refresh"` \| `"session.navigation"` \| `"auth.signin_failed"` \| `"auth.signin_cancelled"` \| `"auth.signin_rejected"` \| `"verify.passive_check"` | [me-client/src/types.ts:338](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L338) | +| <a id="property-session_id"></a> `session_id?` | `string` | [me-client/src/types.ts:347](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L347) | +| <a id="property-timestamp"></a> `timestamp` | `string` | [me-client/src/types.ts:346](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L346) | diff --git a/src/pages/sdk/me-client/interfaces/TrustAttestationCount.mdx b/src/pages/sdk/me-client/interfaces/TrustAttestationCount.mdx new file mode 100644 index 0000000..52a6b25 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/TrustAttestationCount.mdx @@ -0,0 +1,29 @@ +export const metadata = { + title: "Interface: TrustAttestationCount", + description: "Auto-generated API reference for Interface: TrustAttestationCount. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / TrustAttestationCount + +# Interface: TrustAttestationCount + +Defined in: [me-client/src/scope.ts:73](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L73) + +Decoded shape of the `trust_attestation_count` scope value. The wire + format is a comma-separated quad: total,good,distinct_good_issuers,caution. + Block-status counts are intentionally omitted from the disclosure + surface — block flags belong to the pseudonymous-issuer side, not + the subject's public score. + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| <a id="property-caution"></a> `caution` | `number` | [me-client/src/scope.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L77) | +| <a id="property-distinct_good_issuers"></a> `distinct_good_issuers` | `number` | [me-client/src/scope.ts:76](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L76) | +| <a id="property-good"></a> `good` | `number` | [me-client/src/scope.ts:75](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L75) | +| <a id="property-total"></a> `total` | `number` | [me-client/src/scope.ts:74](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L74) | diff --git a/src/pages/sdk/me-client/interfaces/ValidationResult.mdx b/src/pages/sdk/me-client/interfaces/ValidationResult.mdx index 3d04243..6869b89 100644 --- a/src/pages/sdk/me-client/interfaces/ValidationResult.mdx +++ b/src/pages/sdk/me-client/interfaces/ValidationResult.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: ValidationResult -Defined in: [me-client/src/types.ts:137](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L137) +Defined in: [me-client/src/types.ts:147](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L147) Result of validating an IntegratorPriceConfig. @@ -19,5 +19,5 @@ Result of validating an IntegratorPriceConfig. | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-errors"></a> `errors` | \{ `message`: `string`; `subtype?`: [`EventSubtype`](../type-aliases/EventSubtype.mdx); \}[] | [me-client/src/types.ts:139](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L139) | -| <a id="property-ok"></a> `ok` | `boolean` | [me-client/src/types.ts:138](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L138) | +| <a id="property-errors"></a> `errors` | \{ `message`: `string`; `subtype?`: [`EventSubtype`](../type-aliases/EventSubtype.mdx); \}[] | [me-client/src/types.ts:149](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L149) | +| <a id="property-ok"></a> `ok` | `boolean` | [me-client/src/types.ts:148](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L148) | diff --git a/src/pages/sdk/me-client/interfaces/VerifyEventResult.mdx b/src/pages/sdk/me-client/interfaces/VerifyEventResult.mdx index 54093d6..e052762 100644 --- a/src/pages/sdk/me-client/interfaces/VerifyEventResult.mdx +++ b/src/pages/sdk/me-client/interfaces/VerifyEventResult.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: VerifyEventResult -Defined in: [me-client/src/event.ts:183](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L183) +Defined in: [me-client/src/event.ts:197](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L197) Result of replay-verifying a billable envelope against the integrator's price config. Every field returned tells the caller @@ -21,6 +21,6 @@ Result of replay-verifying a billable envelope against the | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-expected"></a> `expected` | \| \{ `gross_fee_sats`: `number`; `platform_fee_sats`: `number`; `site_rebate_sats`: `number`; `user_earned_sats`: `number`; \} \| `null` | What computeFees() returned for the envelope's subtype + amount, given the integrator's current price config. Useful for the /audit divergence tracker — render expected vs actual side by side. Null when the subtype isn't enabled for this integrator. | [me-client/src/event.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L205) | -| <a id="property-issues"></a> `issues` | \{ `actual`: `number` \| `null`; `expected`: `number` \| `null`; `field`: \| `"gross_fee_sats"` \| `"platform_fee_sats"` \| `"user_earned_sats"` \| `"site_rebate_sats"` \| `"subtype_disabled"` \| `"subtype_unconfigured"` \| `"percent_amount_missing"`; `message`: `string`; \}[] | Issues found during verification, with field-level granularity so callers can highlight exactly which line is off. | [me-client/src/event.ts:188](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L188) | -| <a id="property-ok"></a> `ok` | `boolean` | True iff every expected fee equals the recorded fee. | [me-client/src/event.ts:185](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L185) | +| <a id="property-expected"></a> `expected` | \| \{ `gross_fee_sats`: `number`; `platform_fee_sats`: `number`; `site_rebate_sats`: `number`; `user_earned_sats`: `number`; \} \| `null` | What computeFees() returned for the envelope's subtype + amount, given the integrator's current price config. Useful for the /audit divergence tracker — render expected vs actual side by side. Null when the subtype isn't enabled for this integrator. | [me-client/src/event.ts:219](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L219) | +| <a id="property-issues"></a> `issues` | \{ `actual`: `number` \| `null`; `expected`: `number` \| `null`; `field`: \| `"gross_fee_sats"` \| `"platform_fee_sats"` \| `"user_earned_sats"` \| `"site_rebate_sats"` \| `"subtype_disabled"` \| `"subtype_unconfigured"` \| `"percent_amount_missing"`; `message`: `string`; \}[] | Issues found during verification, with field-level granularity so callers can highlight exactly which line is off. | [me-client/src/event.ts:202](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L202) | +| <a id="property-ok"></a> `ok` | `boolean` | True iff every expected fee equals the recorded fee. | [me-client/src/event.ts:199](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L199) | diff --git a/src/pages/sdk/me-client/interfaces/WebhookHeaders.mdx b/src/pages/sdk/me-client/interfaces/WebhookHeaders.mdx new file mode 100644 index 0000000..2e1cc53 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/WebhookHeaders.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Interface: WebhookHeaders", + description: "Auto-generated API reference for Interface: WebhookHeaders. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / WebhookHeaders + +# Interface: WebhookHeaders + +Defined in: [me-client/src/types.ts:277](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L277) + +HTTP headers OC sends with every webhook delivery. Capture these in +the receive handler · `OC-Signature` is what verifies the body. + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-oc-class"></a> `OC-Class` | [`EventClass`](../type-aliases/EventClass.mdx) | Class · matches payload.class. | [me-client/src/types.ts:291](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L291) | +| <a id="property-oc-delivery-attempt"></a> `OC-Delivery-Attempt` | `string` | 1-indexed delivery attempt count. >1 means the prior attempt did not return a 2xx within the timeout · idempotency key on payload.id is critical. | [me-client/src/types.ts:295](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L295) | +| <a id="property-oc-envelope-id"></a> `OC-Envelope-Id` | `string` | Envelope id · matches payload.id; useful for idempotent receive handlers that dedupe on this header without parsing the body. | [me-client/src/types.ts:286](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L286) | +| <a id="property-oc-key-id"></a> `OC-Key-Id` | `string` | Stable kid of the signing key · resolves against ochk.io/.well-known/jwks.json. | [me-client/src/types.ts:282](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L282) | +| <a id="property-oc-signature"></a> `OC-Signature` | `string` | Ed25519 signature over the raw response body, hex-encoded. | [me-client/src/types.ts:279](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L279) | +| <a id="property-oc-subtype"></a> `OC-Subtype` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | Subtype · matches payload.subtype; lets routers branch on the header before parsing. | [me-client/src/types.ts:289](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L289) | diff --git a/src/pages/sdk/me-client/interfaces/WebhookPayload.mdx b/src/pages/sdk/me-client/interfaces/WebhookPayload.mdx new file mode 100644 index 0000000..127bf50 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/WebhookPayload.mdx @@ -0,0 +1,60 @@ +export const metadata = { + title: "Interface: WebhookPayload", + description: "Auto-generated API reference for Interface: WebhookPayload. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / WebhookPayload + +# Interface: WebhookPayload + +Defined in: [me-client/src/types.ts:244](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L244) + +The exact JSON body delivered to a registered webhook endpoint when +a billable event fires. Imported by integrator backends so the +receive handler is type-checked end-to-end without re-declaring the +shape. + + import type { WebhookPayload } from '@orangecheck/me-client'; + + export async function POST(req: Request) { + const payload = (await req.json()) as WebhookPayload; + if (payload.subtype === 'payment_authorization') { + creditUser(payload.sub, payload.user_earned_sats); + } + } + +Headers carry the signature and metadata (see WebhookHeaders below). +Verify the signature with `oc.webhook.verify({ body, headers, jwks })`. + +Privacy contract · the master oc identity is NEVER in the payload. +Integrators see `sub` (per-integrator anonymous id) plus any +`scopes` the user explicitly granted. See PRIVACY-ARCHITECTURE.md. + +## Extends + +- [`BillableEvent`](BillableEvent.mdx) + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| <a id="property-class"></a> `class` | [`EventClass`](../type-aliases/EventClass.mdx) | - | [`BillableEvent`](BillableEvent.mdx).[`class`](BillableEvent.mdx#property-class) | [me-client/src/types.ts:203](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L203) | +| <a id="property-gross_fee_sats"></a> `gross_fee_sats` | `number` | - | [`BillableEvent`](BillableEvent.mdx).[`gross_fee_sats`](BillableEvent.mdx#property-gross_fee_sats) | [me-client/src/types.ts:206](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L206) | +| <a id="property-id"></a> `id` | `string` | - | [`BillableEvent`](BillableEvent.mdx).[`id`](BillableEvent.mdx#property-id) | [me-client/src/types.ts:201](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L201) | +| <a id="property-is_agent"></a> `is_agent?` | `boolean` | Per OCHK-V3-PLAN §7 phase-1 · true when the event was fired by an oc-agent delegation rather than a human session. The integrator's IntegratorEventConfig.agent block may price these differently or refuse them. Optional · canonical encoder branches to v=3 only when present, so legacy human-fired events keep their v=2 hash + signature. | [`BillableEvent`](BillableEvent.mdx).[`is_agent`](BillableEvent.mdx#property-is_agent) | [me-client/src/types.ts:217](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L217) | +| <a id="property-kind"></a> `kind` | `"oc-billable-event"` | Discriminator · identifies the payload kind for routing on the integrator's side. Always 'oc-billable-event' today; future webhook payload kinds (refunds, charters, etc) will use distinct discriminator values. | - | [me-client/src/types.ts:249](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L249) | +| <a id="property-occurred_at"></a> `occurred_at` | `string` | - | [`BillableEvent`](BillableEvent.mdx).[`occurred_at`](BillableEvent.mdx#property-occurred_at) | [me-client/src/types.ts:202](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L202) | +| <a id="property-platform_fee_sats"></a> `platform_fee_sats` | `number` | - | [`BillableEvent`](BillableEvent.mdx).[`platform_fee_sats`](BillableEvent.mdx#property-platform_fee_sats) | [me-client/src/types.ts:207](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L207) | +| <a id="property-scopes"></a> `scopes?` | `Partial`\<`Record`\< \| `"bitcoin_address"` \| `"email"` \| `"attest_tier"` \| `"display_name"` \| `"cross_integrator_event_count"` \| `"cross_integrator_human_event_count"` \| `"trust_attestation_count"` \| `"trust_attestations_bundle"`, `string`\>\> | Resolved scoped fields · only present for scopes the user has granted to this project. Wire format is string-keyed (every value is stringified · ints stringified, addresses as-is). | - | [me-client/src/types.ts:258](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L258) | +| <a id="property-site"></a> `site` | \{ `display_name`: `string`; `domain`: `string`; \} | - | [`BillableEvent`](BillableEvent.mdx).[`site`](BillableEvent.mdx#property-site) | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| `site.display_name` | `string` | - | - | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| `site.domain` | `string` | - | - | [me-client/src/types.ts:205](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L205) | +| <a id="property-site_rebate_sats"></a> `site_rebate_sats` | `number` | - | [`BillableEvent`](BillableEvent.mdx).[`site_rebate_sats`](BillableEvent.mdx#property-site_rebate_sats) | [me-client/src/types.ts:209](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L209) | +| <a id="property-sub"></a> `sub` | `string` | Per-integrator anonymous subject id · stable across events for the same (oc_identity, project_key) pair. Key your user records on this; OC will never give you the master address unless the user explicitly grants `bitcoin_address` or `email` scope. | - | [me-client/src/types.ts:254](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L254) | +| <a id="property-subtype"></a> `subtype` | [`EventSubtype`](../type-aliases/EventSubtype.mdx) | - | [`BillableEvent`](BillableEvent.mdx).[`subtype`](BillableEvent.mdx#property-subtype) | [me-client/src/types.ts:204](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L204) | +| <a id="property-user_earned_sats"></a> `user_earned_sats` | `number` | - | [`BillableEvent`](BillableEvent.mdx).[`user_earned_sats`](BillableEvent.mdx#property-user_earned_sats) | [me-client/src/types.ts:208](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L208) | +| <a id="property-verify_url"></a> `verify_url` | `string` | - | [`BillableEvent`](BillableEvent.mdx).[`verify_url`](BillableEvent.mdx#property-verify_url) | [me-client/src/types.ts:210](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L210) | diff --git a/src/pages/sdk/me-client/interfaces/WithRateLimitRetryOptions.mdx b/src/pages/sdk/me-client/interfaces/WithRateLimitRetryOptions.mdx new file mode 100644 index 0000000..2f5ef84 --- /dev/null +++ b/src/pages/sdk/me-client/interfaces/WithRateLimitRetryOptions.mdx @@ -0,0 +1,22 @@ +export const metadata = { + title: "Interface: WithRateLimitRetryOptions", + description: "Auto-generated API reference for Interface: WithRateLimitRetryOptions. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / WithRateLimitRetryOptions + +# Interface: WithRateLimitRetryOptions + +Defined in: [me-client/src/transport.ts:132](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L132) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-basebackoffms"></a> `baseBackoffMs?` | `number` | Floor backoff in milliseconds when no Retry-After is present. Multiplied by 2^attempt for exponential growth. Default 250ms. | [me-client/src/transport.ts:143](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L143) | +| <a id="property-maxretries"></a> `maxRetries?` | `number` | Maximum retry attempts on 429. Default 2 (= up to 3 total invocations of the wrapped function). | [me-client/src/transport.ts:135](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L135) | +| <a id="property-maxretryafterseconds"></a> `maxRetryAfterSeconds?` | `number` | Cap on Retry-After we'll actually honor in seconds. Some server configs return very large values; the SDK refuses to sleep beyond this and re-throws the original error so the caller decides. Default 30. | [me-client/src/transport.ts:140](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/transport.ts#L140) | diff --git a/src/pages/sdk/me-client/type-aliases/AttestTier.mdx b/src/pages/sdk/me-client/type-aliases/AttestTier.mdx index 3ea5d3c..a84e19d 100644 --- a/src/pages/sdk/me-client/type-aliases/AttestTier.mdx +++ b/src/pages/sdk/me-client/type-aliases/AttestTier.mdx @@ -12,7 +12,18 @@ export const metadata = { # Type Alias: AttestTier ```ts -type AttestTier = "anonymous" | "bonded" | "kyc_light" | "kyc_strong"; +type AttestTier = "anonymous" | "bonded"; ``` -Defined in: [me-client/src/types.ts:56](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L56) +Defined in: [me-client/src/types.ts:66](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L66) + +AttestTier · what an integrator's gate can read about an oc identity. + + me.ochk does NOT do KYC. Sybil resistance is bounded by three + composable mechanisms, none of which involve OC handling PII: + 1. paid-action history · billable events cost real sats + 2. BIP-322 sat-bonding · bond size + age via signed attestation + 3. integrator-defined gates · per-site threat-model overlays + + Tier itself is intentionally simple — anonymous | bonded. + Granularity (bond_sats, bond_locked_at, etc) carried separately. diff --git a/src/pages/sdk/me-client/type-aliases/ClassASubtype.mdx b/src/pages/sdk/me-client/type-aliases/ClassASubtype.mdx index be2b60b..832c712 100644 --- a/src/pages/sdk/me-client/type-aliases/ClassASubtype.mdx +++ b/src/pages/sdk/me-client/type-aliases/ClassASubtype.mdx @@ -15,7 +15,7 @@ export const metadata = { type ClassASubtype = | "account_creation" | "account_recovery" - | "kyc_tier_upgrade" + | "attest_bond_increased" | "payment_method_connected" | "agent_delegation_issued" | "recovery_method_updated"; diff --git a/src/pages/sdk/me-client/type-aliases/FamilyVerb.mdx b/src/pages/sdk/me-client/type-aliases/FamilyVerb.mdx new file mode 100644 index 0000000..ffd7078 --- /dev/null +++ b/src/pages/sdk/me-client/type-aliases/FamilyVerb.mdx @@ -0,0 +1,18 @@ +export const metadata = { + title: "Type Alias: FamilyVerb", + description: "Auto-generated API reference for Type Alias: FamilyVerb. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / FamilyVerb + +# Type Alias: FamilyVerb + +```ts +type FamilyVerb = "oc-vote" | "oc-stamp" | "oc-agent" | "oc-attest" | "oc-lock"; +``` + +Defined in: [me-client/src/family.ts:32](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L32) diff --git a/src/pages/sdk/me-client/type-aliases/FederationStatus.mdx b/src/pages/sdk/me-client/type-aliases/FederationStatus.mdx index 3c013d9..8ba396c 100644 --- a/src/pages/sdk/me-client/type-aliases/FederationStatus.mdx +++ b/src/pages/sdk/me-client/type-aliases/FederationStatus.mdx @@ -15,4 +15,4 @@ export const metadata = { type FederationStatus = "recruiting" | "forming" | "binding" | "live"; ``` -Defined in: [me-client/src/types.ts:262](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L262) +Defined in: [me-client/src/types.ts:357](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L357) diff --git a/src/pages/sdk/me-client/type-aliases/IntegratorArchetype.mdx b/src/pages/sdk/me-client/type-aliases/IntegratorArchetype.mdx new file mode 100644 index 0000000..80299bf --- /dev/null +++ b/src/pages/sdk/me-client/type-aliases/IntegratorArchetype.mdx @@ -0,0 +1,23 @@ +export const metadata = { + title: "Type Alias: IntegratorArchetype", + description: "Auto-generated API reference for Type Alias: IntegratorArchetype. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / IntegratorArchetype + +# Type Alias: IntegratorArchetype + +```ts +type IntegratorArchetype = + | "saas-paywall" + | "marketplace" + | "content-platform" + | "gaming" + | "agent-only"; +``` + +Defined in: [me-client/src/templates.ts:40](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L40) diff --git a/src/pages/sdk/me-client/type-aliases/Scope.mdx b/src/pages/sdk/me-client/type-aliases/Scope.mdx index f37fc6e..d3c928a 100644 --- a/src/pages/sdk/me-client/type-aliases/Scope.mdx +++ b/src/pages/sdk/me-client/type-aliases/Scope.mdx @@ -12,10 +12,27 @@ export const metadata = { # Type Alias: Scope ```ts -type Scope = "bitcoin_address" | "email" | "attest_tier" | "display_name"; +type Scope = + | "bitcoin_address" + | "email" + | "attest_tier" + | "display_name" + | "cross_integrator_event_count" + | "cross_integrator_human_event_count" + | "trust_attestation_count"; ``` -Defined in: [me-client/src/scope.ts:39](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L39) +Defined in: [me-client/src/scope.ts:49](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L49) Catalog of valid scopes · keep in sync with SCOPE_IDS in oc-me-web/src/lib/privacy/scopes.ts. + + cross_integrator_event_count · per OCHK-V2-PLAN §7 · low-info + sybil signal aggregating event count across every integrator. + cross_integrator_human_event_count · per OCHK-V3-PLAN §7 · same + aggregate filtered to is_agent !== true (human-fired only). + Use when you want to gate on real human activity rather than + bot-padded counts. + trust_attestation_count · per OCHK-V3-PLAN §6 phase-2 · four-int + selective-disclosure quad summarizing reputation-graph attestations. + Use parseTrustAttestationCount() to decode the wire-format string. diff --git a/src/pages/sdk/me-client/type-aliases/SigningMethod.mdx b/src/pages/sdk/me-client/type-aliases/SigningMethod.mdx index 34e4c1b..2ddbe9a 100644 --- a/src/pages/sdk/me-client/type-aliases/SigningMethod.mdx +++ b/src/pages/sdk/me-client/type-aliases/SigningMethod.mdx @@ -15,7 +15,7 @@ export const metadata = { type SigningMethod = "fedimint_threshold" | "fedimint_client" | "bip322"; ``` -Defined in: [me-client/src/types.ts:296](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L296) +Defined in: [me-client/src/types.ts:391](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L391) SigningMethod discriminator on the user identity. Federation-agnostic by construction — the OC identity (did:email or BIP-322 address) diff --git a/src/pages/sdk/me-client/type-aliases/SiteFeeShape.mdx b/src/pages/sdk/me-client/type-aliases/SiteFeeShape.mdx index b9287fd..686daaf 100644 --- a/src/pages/sdk/me-client/type-aliases/SiteFeeShape.mdx +++ b/src/pages/sdk/me-client/type-aliases/SiteFeeShape.mdx @@ -23,7 +23,7 @@ type SiteFeeShape = }; ``` -Defined in: [me-client/src/types.ts:60](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L60) +Defined in: [me-client/src/types.ts:70](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/types.ts#L70) The shape of a per-event fee — either a fixed sats amount or a percent of the underlying transaction amount (used for payments + pledges). diff --git a/src/pages/sdk/me-client/variables/ALL_EVENT_SUBTYPES.mdx b/src/pages/sdk/me-client/variables/ALL_EVENT_SUBTYPES.mdx new file mode 100644 index 0000000..2b26745 --- /dev/null +++ b/src/pages/sdk/me-client/variables/ALL_EVENT_SUBTYPES.mdx @@ -0,0 +1,20 @@ +export const metadata = { + title: "Variable: ALLEVENTSUBTYPES", + description: "Auto-generated API reference for Variable: ALLEVENTSUBTYPES. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / ALL\_EVENT\_SUBTYPES + +# Variable: ALL\_EVENT\_SUBTYPES + +```ts +const ALL_EVENT_SUBTYPES: readonly EventSubtypeMetadata[]; +``` + +Defined in: [me-client/src/subtypes.ts:184](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L184) + +All subtypes as a flat list, ordered class A → B → C. diff --git a/src/pages/sdk/me-client/variables/ARCHETYPE_TEMPLATES.mdx b/src/pages/sdk/me-client/variables/ARCHETYPE_TEMPLATES.mdx new file mode 100644 index 0000000..f245641 --- /dev/null +++ b/src/pages/sdk/me-client/variables/ARCHETYPE_TEMPLATES.mdx @@ -0,0 +1,23 @@ +export const metadata = { + title: "Variable: ARCHETYPETEMPLATES", + description: "Auto-generated API reference for Variable: ARCHETYPETEMPLATES. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / ARCHETYPE\_TEMPLATES + +# Variable: ARCHETYPE\_TEMPLATES + +```ts +const ARCHETYPE_TEMPLATES: readonly ArchetypeTemplate[]; +``` + +Defined in: [me-client/src/templates.ts:84](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/templates.ts#L84) + +The full archetype catalog. Add new templates here · one record per +common integrator pattern. Keep the list curated (≤8 archetypes) — +if there are too many, none feel like the obvious default and +integrators stall on the picker. diff --git a/src/pages/sdk/me-client/variables/EVENT_SUBTYPES.mdx b/src/pages/sdk/me-client/variables/EVENT_SUBTYPES.mdx new file mode 100644 index 0000000..5c7ef8a --- /dev/null +++ b/src/pages/sdk/me-client/variables/EVENT_SUBTYPES.mdx @@ -0,0 +1,18 @@ +export const metadata = { + title: "Variable: EVENTSUBTYPES", + description: "Auto-generated API reference for Variable: EVENTSUBTYPES. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / EVENT\_SUBTYPES + +# Variable: EVENT\_SUBTYPES + +```ts +const EVENT_SUBTYPES: Record; +``` + +Defined in: [me-client/src/subtypes.ts:50](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/subtypes.ts#L50) diff --git a/src/pages/sdk/me-client/variables/config.mdx b/src/pages/sdk/me-client/variables/config.mdx index 2b58ab5..1bcf8e3 100644 --- a/src/pages/sdk/me-client/variables/config.mdx +++ b/src/pages/sdk/me-client/variables/config.mdx @@ -13,14 +13,20 @@ export const metadata = { ```ts const config: { + archetypes: readonly ArchetypeTemplate[]; + fromTemplate: (useCase: IntegratorArchetype, identity: ProjectIdentity) => IntegratorPriceConfig; + getArchetype: (id: IntegratorArchetype) => ArchetypeTemplate; validate: (cfg: IntegratorPriceConfig) => ValidationResult; }; ``` -Defined in: [me-client/src/config.ts:25](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L25) +Defined in: [me-client/src/config.ts:49](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L49) ## Type Declaration -| Name | Type | Defined in | -| ------ | ------ | ------ | -| <a id="property-validate"></a> `validate()` | (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx) | [me-client/src/config.ts:25](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L25) | +| Name | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| <a id="property-archetypes"></a> `archetypes` | readonly [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx)[] | `ARCHETYPE_TEMPLATES` | All available archetypes · render in a picker. | [me-client/src/config.ts:56](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L56) | +| <a id="property-fromtemplate"></a> `fromTemplate()` | (`useCase`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx), `identity`: `ProjectIdentity`) => [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx) | - | Build a complete IntegratorPriceConfig from an archetype id + the project's identity fields. Every subtype gets an entry — the archetype's listed subtypes get the template's pricing; everything else gets `enabled: false` with conservative defaults so the config is type-complete and the integrator can flip-on later subtypes without re-deriving prices. Throws synchronously if `useCase` isn't a known archetype id. | [me-client/src/config.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L51) | +| <a id="property-getarchetype"></a> `getArchetype()` | (`id`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx)) => [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx) | `getArchetypeTemplate` | Look up a template's metadata · for rendering "you picked X" state and offering one-click swaps in your own UI. Look up a template's metadata · used by config-editor UIs to render "you're on the X template · here's what it enables" copy. | [me-client/src/config.ts:54](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L54) | +| <a id="property-validate"></a> `validate()` | (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx) | - | - | [me-client/src/config.ts:50](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L50) | diff --git a/src/pages/sdk/me-client/variables/event.mdx b/src/pages/sdk/me-client/variables/event.mdx index 92c5d54..24daf98 100644 --- a/src/pages/sdk/me-client/variables/event.mdx +++ b/src/pages/sdk/me-client/variables/event.mdx @@ -19,12 +19,12 @@ const event: { }; ``` -Defined in: [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) +Defined in: [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) ## Type Declaration | Name | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-fire"></a> `fire()` | (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\> | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | -| <a id="property-firebatch"></a> `fireBatch()` | (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\> | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | -| <a id="property-verify"></a> `verify()` | (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx) | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | +| <a id="property-fire"></a> `fire()` | (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\> | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | +| <a id="property-firebatch"></a> `fireBatch()` | (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\> | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | +| <a id="property-verify"></a> `verify()` | (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx) | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | diff --git a/src/pages/sdk/me-client/variables/family.mdx b/src/pages/sdk/me-client/variables/family.mdx new file mode 100644 index 0000000..4b2f9b9 --- /dev/null +++ b/src/pages/sdk/me-client/variables/family.mdx @@ -0,0 +1,26 @@ +export const metadata = { + title: "Variable: family", + description: "Auto-generated API reference for Variable: family. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/me-client**](../README.mdx) + +*** + +[@orangecheck/me-client](../README.mdx) / family + +# Variable: family + +```ts +const family: { + scopes: (verb: FamilyVerb, options?: FamilyScopesOptions) => Promise; +}; +``` + +Defined in: [me-client/src/family.ts:110](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L110) + +## Type Declaration + +| Name | Type | Defined in | +| ------ | ------ | ------ | +| <a id="property-scopes"></a> `scopes()` | (`verb`: [`FamilyVerb`](../type-aliases/FamilyVerb.mdx), `options?`: [`FamilyScopesOptions`](../interfaces/FamilyScopesOptions.mdx)) => `Promise`\<[`FamilyScopesResult`](../interfaces/FamilyScopesResult.mdx)\> | [me-client/src/family.ts:110](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L110) | diff --git a/src/pages/sdk/me-client/variables/oc.mdx b/src/pages/sdk/me-client/variables/oc.mdx index 09fd18d..17a94b5 100644 --- a/src/pages/sdk/me-client/variables/oc.mdx +++ b/src/pages/sdk/me-client/variables/oc.mdx @@ -14,6 +14,9 @@ export const metadata = { ```ts const oc: { config: { + archetypes: readonly ArchetypeTemplate[]; + fromTemplate: (useCase: IntegratorArchetype, identity: ProjectIdentity) => IntegratorPriceConfig; + getArchetype: (id: IntegratorArchetype) => ArchetypeTemplate; validate: (cfg: IntegratorPriceConfig) => ValidationResult; }; event: { @@ -21,6 +24,9 @@ const oc: { fireBatch: (options: FireBatchOptions) => Promise; verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult; }; + family: { + scopes: (verb: FamilyVerb, options?: FamilyScopesOptions) => Promise; + }; federations: { defaultLive: () => Promise; get: (slug: string) => Promise; @@ -32,6 +38,9 @@ const oc: { }; scope: { granted: (options: GrantedOptions) => Promise; + parseTrustAttestationCount: (value: string) => + | TrustAttestationCount + | null; request: (scopes: Scope[], options: RequestOptions) => never; }; session: { @@ -46,37 +55,44 @@ const oc: { }; ``` -Defined in: [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) +Defined in: [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) Convenience namespace mirroring the public API surface in /integrate code samples — `oc.session.create()`, `oc.payment.authorize()`, `oc.event.fire()`, `oc.config.validate()`, `oc.webhook.verify()`, - `oc.federations.live()`, `oc.scope.granted()` / `oc.scope.request()`. + `oc.federations.live()`, `oc.scope.granted()` / `oc.scope.request()`, + `oc.family.scopes()`. ## Type Declaration -| Name | Type | Default value | Defined in | -| ------ | ------ | ------ | ------ | -| <a id="property-config"></a> `config` | \{ `validate`: (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx); \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `config.validate()` | (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx) | - | [me-client/src/config.ts:25](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L25) | -| <a id="property-event"></a> `event` | \{ `fire`: (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\>; `fireBatch`: (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\>; `verify`: (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx); \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `event.fire()` | (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\> | - | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | -| `event.fireBatch()` | (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\> | - | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | -| `event.verify()` | (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx) | - | [me-client/src/event.ts:329](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L329) | -| <a id="property-federations"></a> `federations` | \{ `defaultLive`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\>; `get`: (`slug`: `string`) => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\>; `list`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\>; `live`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\>; \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `federations.defaultLive()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\> | - | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | -| `federations.get()` | (`slug`: `string`) => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\> | - | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | -| `federations.list()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\> | - | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | -| `federations.live()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\> | - | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | -| <a id="property-payment"></a> `payment` | \{ `authorize`: (`opts`: [`PaymentAuthorizeOptions`](../interfaces/PaymentAuthorizeOptions.mdx)) => `Promise`\<[`PaymentResult`](../interfaces/PaymentResult.mdx)\>; \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `payment.authorize()` | (`opts`: [`PaymentAuthorizeOptions`](../interfaces/PaymentAuthorizeOptions.mdx)) => `Promise`\<[`PaymentResult`](../interfaces/PaymentResult.mdx)\> | - | [me-client/src/payment.ts:25](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/payment.ts#L25) | -| <a id="property-scope"></a> `scope` | \{ `granted`: (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\>; `request`: (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never`; \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `scope.granted()` | (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\> | - | [me-client/src/scope.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L144) | -| `scope.request()` | (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never` | - | [me-client/src/scope.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L144) | -| <a id="property-session"></a> `session` | \{ `create`: (`opts`: [`SignInOptions`](../interfaces/SignInOptions.mdx)) => `Promise`\<[`Session`](../interfaces/Session.mdx)\>; `invalidate`: (`sessionId`: `string`) => `Promise`\<`void`\>; `refresh`: (`sessionId`: `string`) => `Promise`\<[`Session`](../interfaces/Session.mdx)\>; \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `session.create()` | (`opts`: [`SignInOptions`](../interfaces/SignInOptions.mdx)) => `Promise`\<[`Session`](../interfaces/Session.mdx)\> | - | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | -| `session.invalidate()` | (`sessionId`: `string`) => `Promise`\<`void`\> | - | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | -| `session.refresh()` | (`sessionId`: `string`) => `Promise`\<[`Session`](../interfaces/Session.mdx)\> | - | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | -| <a id="property-webhook"></a> `webhook` | \{ `fetchJwks`: (`issuer`: `string`) => `Promise`\<`void`\>; `verify`: (`rawBody`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>, `sigHex`: `string`, `kid`: `string`, `options`: [`VerifyOptions`](../interfaces/VerifyOptions.mdx)) => `Promise`\<[`VerifyResult`](../interfaces/VerifyResult.mdx)\>; \} | - | [me-client/src/index.ts:107](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L107) | -| `webhook.fetchJwks()` | (`issuer`: `string`) => `Promise`\<`void`\> | `fetchJwksForce` | [me-client/src/webhook.ts:221](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/webhook.ts#L221) | -| `webhook.verify()` | (`rawBody`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>, `sigHex`: `string`, `kid`: `string`, `options`: [`VerifyOptions`](../interfaces/VerifyOptions.mdx)) => `Promise`\<[`VerifyResult`](../interfaces/VerifyResult.mdx)\> | - | [me-client/src/webhook.ts:221](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/webhook.ts#L221) | +| Name | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| <a id="property-config"></a> `config` | \{ `archetypes`: readonly [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx)[]; `fromTemplate`: (`useCase`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx), `identity`: `ProjectIdentity`) => [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx); `getArchetype`: (`id`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx)) => [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx); `validate`: (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx); \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `config.archetypes` | readonly [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx)[] | `ARCHETYPE_TEMPLATES` | All available archetypes · render in a picker. | [me-client/src/config.ts:56](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L56) | +| `config.fromTemplate()` | (`useCase`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx), `identity`: `ProjectIdentity`) => [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx) | - | Build a complete IntegratorPriceConfig from an archetype id + the project's identity fields. Every subtype gets an entry — the archetype's listed subtypes get the template's pricing; everything else gets `enabled: false` with conservative defaults so the config is type-complete and the integrator can flip-on later subtypes without re-deriving prices. Throws synchronously if `useCase` isn't a known archetype id. | [me-client/src/config.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L51) | +| `config.getArchetype()` | (`id`: [`IntegratorArchetype`](../type-aliases/IntegratorArchetype.mdx)) => [`ArchetypeTemplate`](../interfaces/ArchetypeTemplate.mdx) | `getArchetypeTemplate` | Look up a template's metadata · for rendering "you picked X" state and offering one-click swaps in your own UI. Look up a template's metadata · used by config-editor UIs to render "you're on the X template · here's what it enables" copy. | [me-client/src/config.ts:54](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L54) | +| `config.validate()` | (`cfg`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx)) => [`ValidationResult`](../interfaces/ValidationResult.mdx) | - | - | [me-client/src/config.ts:50](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/config.ts#L50) | +| <a id="property-event"></a> `event` | \{ `fire`: (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\>; `fireBatch`: (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\>; `verify`: (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx); \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `event.fire()` | (`options`: [`FireEventOptions`](../interfaces/FireEventOptions.mdx)) => `Promise`\<[`BillableEvent`](../interfaces/BillableEvent.mdx)\> | - | - | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | +| `event.fireBatch()` | (`options`: `FireBatchOptions`) => `Promise`\<`FireBatchResponse`\> | - | `oc.event.fireBatch` — bulk-ingest up to 100 billable envelopes under one project_key in a single HTTP round-trip. Wins amortize across the batch: one auth roundtrip, one project lookup, one scope-grants resolve, parallel KV writes via Promise.all. For a 50-event batch the server-side processing time drops from ~3-4.5 seconds (50 sequential per-event POSTs) to ~100-200ms. import { oc } from '@orangecheck/me-client'; const res = await oc.event.fireBatch({ project_key: 'pk_live_yourcompany', events: [ { subtype: 'session_creation' }, { subtype: 'page_view', action_label: 'home' }, { subtype: 'page_view', action_label: 'pricing' }, ], }); for (const r of res.results) { if (r.status === 'recorded') console.log('+', r.event.id, r.event.gross_fee_sats); else if (r.status === 'duplicate') console.log('~ idempotent replay', r.event.id); else console.log('!', r.reason); } Failure modes: - 400 if events.length === 0 or > 100, or events[].subtype missing - 403 if the project is frozen or the domain is unverified - 429 if the project's rate limit (1000 events/sec sustained) is exceeded; Retry-After header indicates backoff. Per OCHK-V3-PLAN §12.2. | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | +| `event.verify()` | (`envelope`: [`BillableEvent`](../interfaces/BillableEvent.mdx), `config`: [`IntegratorPriceConfig`](../interfaces/IntegratorPriceConfig.mdx), `payment_amount_sats?`: `number`) => [`VerifyEventResult`](../interfaces/VerifyEventResult.mdx) | - | Replay-verify a billable envelope against the integrator's current price config. Re-runs computeFees() with the same inputs and compares against the four-way split recorded on the envelope. Anyone — the integrator, a user, OC, an auditor — can run this function and reach the same answer. The integrator-side replay is what keeps OC honest: a divergence means OC's billing engine computed differently than the published price config says it should have, and the integrator can flag it on /audit. For percent_of_amount-priced subtypes, the underlying payment amount must be passed explicitly (it isn't stored on the envelope top-level — only inside the context payload — so callers should pass `envelope.context.payment_amount_sats`). import { oc } from '@orangecheck/me-client'; const env = await fetch(`https://me.ochk.io/api/envelope/${id}`).then(r => r.json()); const cfg = await oc.config.fetch({ project_key: env.site.domain }); const result = oc.event.verify(env, cfg); if (!result.ok) reportDivergence(result.issues); | [me-client/src/event.ts:343](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/event.ts#L343) | +| <a id="property-family"></a> `family` | \{ `scopes`: (`verb`: [`FamilyVerb`](../type-aliases/FamilyVerb.mdx), `options?`: [`FamilyScopesOptions`](../interfaces/FamilyScopesOptions.mdx)) => `Promise`\<[`FamilyScopesResult`](../interfaces/FamilyScopesResult.mdx)\>; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `family.scopes()` | (`verb`: [`FamilyVerb`](../type-aliases/FamilyVerb.mdx), `options?`: [`FamilyScopesOptions`](../interfaces/FamilyScopesOptions.mdx)) => `Promise`\<[`FamilyScopesResult`](../interfaces/FamilyScopesResult.mdx)\> | - | Read the cross-family scope grants the user has issued to the named sibling product. Browser-side · uses cookie credentials. Errors thrown: - `unknown_family_verb` if `verb` is not in the family allowlist - `sign in required` (401) if no oc_session cookie present - `unknown_family_verb` (404) if me.ochk doesn't recognize the verb If you need to drive a consent prompt for a verb the user hasn't granted yet, use `oc.scope.request(scopes, { project_key: 'family:', return_to })` — the consent prompt page detects the `family:` prefix and renders the sibling-product chrome. | [me-client/src/family.ts:110](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/family.ts#L110) | +| <a id="property-federations"></a> `federations` | \{ `defaultLive`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\>; `get`: (`slug`: `string`) => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\>; `list`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\>; `live`: () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\>; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `federations.defaultLive()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\> | - | Default federation a fresh user/integrator should bind to when no explicit policy exists yet. v1: the first live federation in the directory; falls back to null if none live yet. v2+: routing policy (geography, capacity, explicit choice) consults the directory directly. | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | +| `federations.get()` | (`slug`: `string`) => `Promise`\<[`Federation`](../interfaces/Federation.mdx) \| `null`\> | - | Look up a single federation by slug. Returns null if the slug isn't in the directory. | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | +| `federations.list()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\> | - | List every federation in the directory — recruiting, forming, binding, and live. Consumers filter by status as needed. | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | +| `federations.live()` | () => `Promise`\<[`Federation`](../interfaces/Federation.mdx)[]\> | - | Return only federations currently accepting bindings — i.e. status === 'live' with a non-null invite. The set the consumer wallet provider can route a user wallet to. | [me-client/src/federations.ts:51](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/federations.ts#L51) | +| <a id="property-payment"></a> `payment` | \{ `authorize`: (`opts`: [`PaymentAuthorizeOptions`](../interfaces/PaymentAuthorizeOptions.mdx)) => `Promise`\<[`PaymentResult`](../interfaces/PaymentResult.mdx)\>; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `payment.authorize()` | (`opts`: [`PaymentAuthorizeOptions`](../interfaces/PaymentAuthorizeOptions.mdx)) => `Promise`\<[`PaymentResult`](../interfaces/PaymentResult.mdx)\> | - | Authorize a payment through the user's OC identity. Class B billable event for the integrating site (sub-Stripe rate, percentage-based); cashback flows to the user as Lightning credit on /me/earn. The user is prompted by me.ochk.io to consent to the specific payment before this resolves. If the user declines or cancels, the result has status `'cancelled'`, a non-billable telemetry record is emitted, and NO billable event is created. | [me-client/src/payment.ts:25](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/payment.ts#L25) | +| <a id="property-scope"></a> `scope` | \{ `granted`: (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\>; `parseTrustAttestationCount`: (`value`: `string`) => \| [`TrustAttestationCount`](../interfaces/TrustAttestationCount.mdx) \| `null`; `request`: (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never`; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `scope.granted()` | (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\> | - | - | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) | +| `scope.parseTrustAttestationCount()` | (`value`: `string`) => \| [`TrustAttestationCount`](../interfaces/TrustAttestationCount.mdx) \| `null` | - | Decode the `trust_attestation_count` scope's wire-format string into a typed quad. Returns null if the input is malformed (defensive · the resolver always emits well-formed strings, but third-party consumers may hand us anything). | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) | +| `scope.request()` | (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never` | - | Redirect the user to me.ochk.io's consent prompt. After they decide, browser returns to `return_to`. The scope grants are persisted server-side; subsequent calls to oc.scope.granted() reflect their decisions. This function does NOT return a promise that resolves to the user's decisions. The redirect leaves your page; the user lands back at return_to and your code re-reads granted state on mount. Consent flow: 1. Your code: oc.scope.request(['email'], { ... }) 2. Browser navigates to me.ochk.io/me/scope-grant?… 3. User decides per-scope (grant once / always / deny) 4. Browser redirects back to return_to 5. Your code re-runs oc.scope.granted(...) on mount Throws synchronously if the inputs are invalid (so the redirect is never issued with malformed params). | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) | +| <a id="property-session"></a> `session` | \{ `create`: (`opts`: [`SignInOptions`](../interfaces/SignInOptions.mdx)) => `Promise`\<[`Session`](../interfaces/Session.mdx)\>; `invalidate`: (`sessionId`: `string`) => `Promise`\<`void`\>; `refresh`: (`sessionId`: `string`) => `Promise`\<[`Session`](../interfaces/Session.mdx)\>; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `session.create()` | (`opts`: [`SignInOptions`](../interfaces/SignInOptions.mdx)) => `Promise`\<[`Session`](../interfaces/Session.mdx)\> | - | Open a sign-in flow at me.ochk.io. Returns the resulting Session once the user consents (Class C billable event for the integrating site, cashback for the user). Internally this opens the OC consent UI in a popup; v1 implementations may also redirect. | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | +| `session.invalidate()` | (`sessionId`: `string`) => `Promise`\<`void`\> | - | Invalidate a session. Free, telemetry-only. | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | +| `session.refresh()` | (`sessionId`: `string`) => `Promise`\<[`Session`](../interfaces/Session.mdx)\> | - | Refresh a still-valid session inside its policy window. Free for the integrating site (does NOT instantiate a billable event); emits a `session.token_refresh` telemetry record. | [me-client/src/session.ts:77](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/session.ts#L77) | +| <a id="property-webhook"></a> `webhook` | \{ `fetchJwks`: (`issuer`: `string`) => `Promise`\<`void`\>; `verify`: (`rawBody`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>, `sigHex`: `string`, `kid`: `string`, `options`: [`VerifyOptions`](../interfaces/VerifyOptions.mdx)) => `Promise`\<[`VerifyResult`](../interfaces/VerifyResult.mdx)\>; \} | - | - | [me-client/src/index.ts:136](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/index.ts#L136) | +| `webhook.fetchJwks()` | (`issuer`: `string`) => `Promise`\<`void`\> | `fetchJwksForce` | Force-refresh the JWKS cache. Useful after a key rotation event if you don't want to wait for the TTL to expire. | [me-client/src/webhook.ts:221](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/webhook.ts#L221) | +| `webhook.verify()` | (`rawBody`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>, `sigHex`: `string`, `kid`: `string`, `options`: [`VerifyOptions`](../interfaces/VerifyOptions.mdx)) => `Promise`\<[`VerifyResult`](../interfaces/VerifyResult.mdx)\> | - | Verify a webhook signature. Pass the raw body bytes (not parsed JSON), the hex-encoded signature from the `OC-Signature` header, and the kid from the `OC-Key-Id` header. Returns `{ ok: true }` on success, `{ ok: false, reason }` on any failure (bad signature, kid not in JWKS, malformed signature, network-only JWKS fetch failed without prior cache, etc.). Never throws. | [me-client/src/webhook.ts:221](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/webhook.ts#L221) | diff --git a/src/pages/sdk/me-client/variables/scope.mdx b/src/pages/sdk/me-client/variables/scope.mdx index c88b495..9ae804c 100644 --- a/src/pages/sdk/me-client/variables/scope.mdx +++ b/src/pages/sdk/me-client/variables/scope.mdx @@ -14,15 +14,19 @@ export const metadata = { ```ts const scope: { granted: (options: GrantedOptions) => Promise; + parseTrustAttestationCount: (value: string) => + | TrustAttestationCount + | null; request: (scopes: Scope[], options: RequestOptions) => never; }; ``` -Defined in: [me-client/src/scope.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L144) +Defined in: [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) ## Type Declaration | Name | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-granted"></a> `granted()` | (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\> | [me-client/src/scope.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L144) | -| <a id="property-request"></a> `request()` | (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never` | [me-client/src/scope.ts:144](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L144) | +| <a id="property-granted"></a> `granted()` | (`options`: [`GrantedOptions`](../interfaces/GrantedOptions.mdx)) => `Promise`\<[`GrantedResult`](../interfaces/GrantedResult.mdx)\> | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) | +| <a id="property-parsetrustattestationcount"></a> `parseTrustAttestationCount()` | (`value`: `string`) => \| [`TrustAttestationCount`](../interfaces/TrustAttestationCount.mdx) \| `null` | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) | +| <a id="property-request"></a> `request()` | (`scopes`: [`Scope`](../type-aliases/Scope.mdx)[], `options`: [`RequestOptions`](../interfaces/RequestOptions.mdx)) => `never` | [me-client/src/scope.ts:193](https://github.com/orangecheck/oc-packages/blob/main/me-client/src/scope.ts#L193) |