@namahapdf/react 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,95 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+
+interface NamahaEditorProps {
+    /** Your NamahaPDF SDK license key. Without it the editor runs in watermarked mode. */
+    licenseKey?: string;
+    /** Override the activation endpoint (defaults to a same-origin /api/license/activate). */
+    activationUrl?: string;
+    /** Extra class on the scoping wrapper. */
+    className?: string;
+    style?: React.CSSProperties;
+}
+/**
+ * A complete in-browser PDF editor — view, edit, annotate, sign, redact, and fill
+ * forms, fully on-device. Pass your `licenseKey` to remove the evaluation watermark
+ * and unlock licensed features.
+ *
+ * Import the stylesheet once in your app: `import '@namahapdf/react/styles.css'`.
+ */
+declare function NamahaEditor({ licenseKey, activationUrl, className, style }: NamahaEditorProps): react_jsx_runtime.JSX.Element;
+
+/** Shared license/activation contracts used by both the engine gate and the server. */
+/** Capabilities a license can unlock. `view`/`annotate` are the always-available base. */
+type LicenseFeature = 'view' | 'annotate' | 'edit-text' | 'sign' | 'redact' | 'forms' | 'export-clean';
+type LicenseEdition = 'trial' | 'pro' | 'enterprise';
+type LicenseStatus = 'UNLICENSED' | 'INVALID' | 'LICENSED' | 'GRACE' | 'DEGRADED';
+interface LicenseState {
+    status: LicenseStatus;
+    edition: LicenseEdition | null;
+    features: LicenseFeature[];
+    /** True when render/export should be watermarked. */
+    watermark: boolean;
+    /** Human-readable reason (for diagnostics; never user-facing copy). */
+    reason: string;
+}
+
+/**
+ * Client-side license gate for the NamahaPDF engine.
+ *
+ * Flow (see configureLicense):
+ *   1. Verify the license key OFFLINE (signature, expiry, domain) — instant, no network.
+ *   2. If a cached activation token is still valid → LICENSED immediately.
+ *   3. Kick a NON-BLOCKING background activation that exchanges the key for a fresh,
+ *      short-TTL activation token (which is also what the server can revoke).
+ *
+ * Offline grace is weighted heavily on purpose: transient network/server failures
+ * never punish a paying customer. We tolerate up to MAX_FAILURES (5) attempts AND a
+ * BOOTSTRAP_GRACE window before degrading — the SDK degrades immediately ONLY on an
+ * explicit signed `revoked`/`invalid` from the server.
+ *
+ * Everything is injectable (storage / fetch / clock / public key) so it is unit-testable
+ * without a browser or a server.
+ */
+
+interface StorageLike {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+}
+interface LicenseConfig {
+    /** The signed license key the developer received. */
+    licenseKey?: string;
+    /** Activation endpoint. Defaults to a same-origin `/api/license/activate`. */
+    activationUrl?: string;
+    /** Stable per-install id; auto-generated + persisted when omitted. */
+    deviceId?: string;
+    /** First-party bypass — our own app passes this so it never watermarks itself. */
+    owner?: boolean;
+    /** Override the embedded public key (tests only). */
+    publicKeyHex?: string;
+    /** Injected clock (tests). */
+    now?: () => number;
+    /** Injected storage (tests / Node). */
+    storage?: StorageLike;
+    /** Injected fetch (tests / Node). */
+    fetchImpl?: typeof fetch;
+    /** Host to domain-check against; defaults to location.hostname in the browser. */
+    host?: string;
+    /** Background retry backoff in ms (tests can shorten). */
+    retryDelays?: number[];
+}
+type Listener = (s: LicenseState) => void;
+/**
+ * Configure (or reconfigure) the license gate. Verifies the key synchronously and
+ * starts a background activation. Returns the immediate state; subscribe with
+ * `onLicenseChange` for updates as activation completes.
+ */
+declare function configureLicense(config?: LicenseConfig): LicenseState;
+/** Current license state (synchronous, cheap). */
+declare function getLicenseState(): LicenseState;
+declare function isFeatureEnabled(feature: LicenseFeature): boolean;
+declare function shouldWatermark(): boolean;
+/** Subscribe to state changes (activation success/failure). Returns an unsubscribe. */
+declare function onLicenseChange(cb: Listener): () => void;
+
+export { type LicenseConfig, type LicenseEdition, type LicenseFeature, type LicenseState, type LicenseStatus, NamahaEditor, type NamahaEditorProps, configureLicense, NamahaEditor as default, getLicenseState, isFeatureEnabled, onLicenseChange, shouldWatermark };

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+
+interface NamahaEditorProps {
+    /** Your NamahaPDF SDK license key. Without it the editor runs in watermarked mode. */
+    licenseKey?: string;
+    /** Override the activation endpoint (defaults to a same-origin /api/license/activate). */
+    activationUrl?: string;
+    /** Extra class on the scoping wrapper. */
+    className?: string;
+    style?: React.CSSProperties;
+}
+/**
+ * A complete in-browser PDF editor — view, edit, annotate, sign, redact, and fill
+ * forms, fully on-device. Pass your `licenseKey` to remove the evaluation watermark
+ * and unlock licensed features.
+ *
+ * Import the stylesheet once in your app: `import '@namahapdf/react/styles.css'`.
+ */
+declare function NamahaEditor({ licenseKey, activationUrl, className, style }: NamahaEditorProps): react_jsx_runtime.JSX.Element;
+
+/** Shared license/activation contracts used by both the engine gate and the server. */
+/** Capabilities a license can unlock. `view`/`annotate` are the always-available base. */
+type LicenseFeature = 'view' | 'annotate' | 'edit-text' | 'sign' | 'redact' | 'forms' | 'export-clean';
+type LicenseEdition = 'trial' | 'pro' | 'enterprise';
+type LicenseStatus = 'UNLICENSED' | 'INVALID' | 'LICENSED' | 'GRACE' | 'DEGRADED';
+interface LicenseState {
+    status: LicenseStatus;
+    edition: LicenseEdition | null;
+    features: LicenseFeature[];
+    /** True when render/export should be watermarked. */
+    watermark: boolean;
+    /** Human-readable reason (for diagnostics; never user-facing copy). */
+    reason: string;
+}
+
+/**
+ * Client-side license gate for the NamahaPDF engine.
+ *
+ * Flow (see configureLicense):
+ *   1. Verify the license key OFFLINE (signature, expiry, domain) — instant, no network.
+ *   2. If a cached activation token is still valid → LICENSED immediately.
+ *   3. Kick a NON-BLOCKING background activation that exchanges the key for a fresh,
+ *      short-TTL activation token (which is also what the server can revoke).
+ *
+ * Offline grace is weighted heavily on purpose: transient network/server failures
+ * never punish a paying customer. We tolerate up to MAX_FAILURES (5) attempts AND a
+ * BOOTSTRAP_GRACE window before degrading — the SDK degrades immediately ONLY on an
+ * explicit signed `revoked`/`invalid` from the server.
+ *
+ * Everything is injectable (storage / fetch / clock / public key) so it is unit-testable
+ * without a browser or a server.
+ */
+
+interface StorageLike {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+}
+interface LicenseConfig {
+    /** The signed license key the developer received. */
+    licenseKey?: string;
+    /** Activation endpoint. Defaults to a same-origin `/api/license/activate`. */
+    activationUrl?: string;
+    /** Stable per-install id; auto-generated + persisted when omitted. */
+    deviceId?: string;
+    /** First-party bypass — our own app passes this so it never watermarks itself. */
+    owner?: boolean;
+    /** Override the embedded public key (tests only). */
+    publicKeyHex?: string;
+    /** Injected clock (tests). */
+    now?: () => number;
+    /** Injected storage (tests / Node). */
+    storage?: StorageLike;
+    /** Injected fetch (tests / Node). */
+    fetchImpl?: typeof fetch;
+    /** Host to domain-check against; defaults to location.hostname in the browser. */
+    host?: string;
+    /** Background retry backoff in ms (tests can shorten). */
+    retryDelays?: number[];
+}
+type Listener = (s: LicenseState) => void;
+/**
+ * Configure (or reconfigure) the license gate. Verifies the key synchronously and
+ * starts a background activation. Returns the immediate state; subscribe with
+ * `onLicenseChange` for updates as activation completes.
+ */
+declare function configureLicense(config?: LicenseConfig): LicenseState;
+/** Current license state (synchronous, cheap). */
+declare function getLicenseState(): LicenseState;
+declare function isFeatureEnabled(feature: LicenseFeature): boolean;
+declare function shouldWatermark(): boolean;
+/** Subscribe to state changes (activation success/failure). Returns an unsubscribe. */
+declare function onLicenseChange(cb: Listener): () => void;
+
+export { type LicenseConfig, type LicenseEdition, type LicenseFeature, type LicenseState, type LicenseStatus, NamahaEditor, type NamahaEditorProps, configureLicense, NamahaEditor as default, getLicenseState, isFeatureEnabled, onLicenseChange, shouldWatermark };