solloop 0.0.0-stage → 0.1.0

package/types/public-types.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The `solloop` npm package's public types, and the only source its published
+ * declarations are emitted from (`scripts/pack-npm.ts`).
+ *
+ * No imports, on purpose. The workspace packages are bundled into the
+ * JavaScript but not published, so a type that reached into `@solloop/core`
+ * would ship a declaration that cannot resolve on a merchant's machine. The
+ * source imports these definitions instead of restating them, and
+ * `tests/public-types.test.ts` pins the ones that mirror an internal type.
+ */
+
+export type SolLoopCluster = 'mainnet-beta' | 'devnet' | 'localnet';
+
+/** What each host event carries: `CustomEvent.detail`, or the React callback's argument. */
+export interface SolLoopEventDetails {
+  'solloop:connected': { address: string };
+  'solloop:subscribing': Record<string, never>;
+  /** A UI hint, not proof of payment: verify on chain or via the webhook. */
+  'solloop:subscribed': { signature: string; subscriptionPda: string };
+  'solloop:error': { code: string; message: string };
+  'solloop:cancelled': Record<string, never>;
+}
+
+export type SolLoopEventName = keyof SolLoopEventDetails;
+
+/** The attributes `<solloop-subscribe>` reads. Unknown values fall back to defaults. */
+export interface SolLoopSubscribeAttributes {
+  /** A SolLoop plan id (`plan_8xK2m`) or a plan PDA. */
+  plan: string;
+  theme?: 'light' | 'auto';
+  /** Hex colour. */
+  accent?: string;
+  /** CSS length for the outer corner radius. */
+  radius?: string;
+  locale?: string;
+  cluster?: SolLoopCluster;
+  rpc?: string;
+  'success-url'?: string;
+  'api-url'?: string;
+}
+
+export interface SolLoopSubscribeProps {
+  /** A SolLoop plan id (`plan_8xK2m`) or a plan PDA. */
+  plan: string;
+  theme?: 'light' | 'auto';
+  /** Hex colour. */
+  accent?: string;
+  /** CSS length for the outer corner radius. */
+  radius?: string;
+  locale?: string;
+  cluster?: SolLoopCluster;
+  rpcUrl?: string;
+  successUrl?: string;
+  apiUrl?: string;
+  className?: string;
+  onConnected?: (detail: SolLoopEventDetails['solloop:connected']) => void;
+  onSubscribing?: () => void;
+  onSubscribed?: (detail: SolLoopEventDetails['solloop:subscribed']) => void;
+  onError?: (detail: SolLoopEventDetails['solloop:error']) => void;
+  onCancelled?: () => void;
+}

package/types/react.d.ts

@@ -0,0 +1,18 @@
+// Published as `solloop/react`'s types; mirrors src/react.tsx.
+import type { ReactElement } from 'react';
+import type { SolLoopSubscribeProps } from './public-types.js';
+
+export type {
+  SolLoopCluster,
+  SolLoopEventDetails,
+  SolLoopSubscribeProps,
+} from './public-types.js';
+
+/**
+ * The subscribe widget for React apps. Renders into a shadow root, so your
+ * global styles cannot reach it.
+ *
+ * `onSubscribed` is a UI hint, not proof of payment: gate access on your
+ * backend by verifying the subscription on chain or via the webhook.
+ */
+export declare function SolLoopSubscribe(props: SolLoopSubscribeProps): ReactElement;