@foir/sdk 0.5.0 → 0.8.0

package/dist/protocol/constants.d.ts

@@ -0,0 +1,6 @@
+/** Protocol version for compatibility checks. */
+export declare const PROTOCOL_VERSION = "1.0";
+/** Maximum allowed iframe resize height in pixels. */
+export declare const MAX_RESIZE_HEIGHT = 100000;
+/** Path segments that must be rejected to prevent prototype pollution. */
+export declare const DANGEROUS_PATH_SEGMENTS: string[];

package/dist/protocol/messages.d.ts

@@ -0,0 +1,155 @@
+/**
+ * PostMessage protocol types between EIDE platform host and extension iframes.
+ *
+ * Inlined from the platform protocol to keep the SDK zero-dep.
+ */
+/**
+ * Messages sent FROM the platform host TO the iframe extension.
+ */
+export type HostToEditorMessage = {
+    type: 'init';
+    payload: {
+        values: Record<string, unknown>;
+        metadata?: Record<string, unknown>;
+        modelKey: string;
+        recordId: string;
+        naturalKey?: string;
+        versionId: string | null;
+        variantKey: string | null;
+        locale: string | null;
+        schema: unknown;
+        mode: 'edit' | 'readonly';
+        theme: 'light' | 'dark';
+        apiKey: string;
+        apiUrl: string;
+        connectionDomain?: string;
+        configMode?: 'editor' | 'sidebar';
+        selectedFieldKeys?: string[];
+        selectableFields?: Array<{
+            key: string;
+            label: string;
+            type: string;
+        }>;
+        localeContext?: {
+            currentLocale: string;
+            sourceLocale: string;
+            isTranslating: boolean;
+            locales: Array<{
+                code: string;
+                displayName: string;
+                isDefault: boolean;
+            }>;
+        };
+    };
+} | {
+    type: 'values-changed';
+    payload: {
+        values: Record<string, unknown>;
+        source: 'remote';
+    };
+} | {
+    type: 'variant-changed';
+    payload: {
+        variantKey: string;
+        values: Record<string, unknown>;
+    };
+} | {
+    type: 'save-result';
+    payload: {
+        success: boolean;
+        error?: string;
+        versionId?: string;
+    };
+} | {
+    type: 'publish-result';
+    payload: {
+        success: boolean;
+        error?: string;
+    };
+} | {
+    type: 'theme-changed';
+    payload: {
+        theme: 'light' | 'dark';
+    };
+} | {
+    type: 'selection-changed';
+    payload: {
+        selectedFieldKeys: string[];
+        fields: Array<{
+            key: string;
+            label: string;
+            type: string;
+        }>;
+    };
+} | {
+    type: 'locale-changed';
+    payload: {
+        currentLocale: string;
+        sourceLocale: string;
+        isTranslating: boolean;
+        locales: Array<{
+            code: string;
+            displayName: string;
+            isDefault: boolean;
+        }>;
+    };
+} | {
+    type: 'operation-result';
+    payload: {
+        requestId: string;
+        success: boolean;
+        result?: unknown;
+        error?: {
+            code: string;
+            message: string;
+        };
+    };
+};
+/**
+ * Messages sent FROM the iframe extension TO the platform host.
+ */
+export type EditorToHostMessage = {
+    type: 'ready';
+    payload: Record<string, never>;
+} | {
+    type: 'update-values';
+    payload: {
+        values: Record<string, unknown>;
+    };
+} | {
+    type: 'update-field';
+    payload: {
+        path: string;
+        value: unknown;
+    };
+} | {
+    type: 'request-save';
+    payload: Record<string, never>;
+} | {
+    type: 'request-publish';
+    payload: Record<string, never>;
+} | {
+    type: 'resize';
+    payload: {
+        height: number;
+    };
+} | {
+    type: 'dirty';
+    payload: {
+        isDirty: boolean;
+    };
+} | {
+    type: 'request-navigate';
+    payload: {
+        path: string;
+    };
+} | {
+    type: 'request-operation';
+    payload: {
+        operationKey: string;
+        input?: Record<string, unknown>;
+        requestId: string;
+        /** Execution mode: 'sync' waits for completion, 'async' queues and returns. */
+        mode?: 'sync' | 'async';
+    };
+};

package/dist/protocol/validation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Runtime validation for postMessage payloads.
+ */
+import type { HostToEditorMessage, EditorToHostMessage } from './messages';
+/** Validate an incoming message from a custom editor iframe (editor -> host). */
+export declare function isValidEditorMessage(data: unknown): data is EditorToHostMessage;
+/** Validate an incoming message from the platform host (host -> editor). */
+export declare function isValidHostMessage(data: unknown): data is HostToEditorMessage;

package/dist/push/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * `@foir/sdk/push` — native Web Push (VAPID) enrolment for browser web apps.
+ *
+ * @example
+ * ```ts
+ * import { enableWebPush } from '@foir/sdk/push';
+ *
+ * await enableWebPush({ adapter, env }); // registers /foir-sw.js + a WEB token
+ * ```
+ */
+export { enableWebPush, disableWebPush, isWebPushSupported, } from './web-push';
+export type { EnableWebPushOptions, EnableWebPushResult, DisableWebPushOptions, } from './web-push';
+export { WebPushConfigDocument, RegisterDeviceTokenDocument, UnregisterDeviceTokenDocument, } from './operations';
+export type { RegisterDeviceTokenInput } from './operations';

package/dist/push/operations.d.ts

@@ -0,0 +1,22 @@
+import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
+/** The project's non-secret VAPID public key a browser subscribes with. */
+export declare const WebPushConfigDocument: TypedDocumentNode<{
+    webPushConfig: {
+        vapidPublicKey: string;
+    } | null;
+}, Record<string, never>>;
+export interface RegisterDeviceTokenInput {
+    token: string;
+    platform: 'IOS' | 'ANDROID' | 'WEB';
+    deviceName?: string;
+}
+export declare const RegisterDeviceTokenDocument: TypedDocumentNode<{
+    registerDeviceToken: boolean;
+}, {
+    input: RegisterDeviceTokenInput;
+}>;
+export declare const UnregisterDeviceTokenDocument: TypedDocumentNode<{
+    unregisterDeviceToken: boolean;
+}, {
+    token: string;
+}>;

package/dist/push/web-push.d.ts

@@ -0,0 +1,39 @@
+import type { SessionAdapter } from '../auth/auth';
+import type { FoirEnv } from '../graphql/foir-request';
+export interface EnableWebPushOptions {
+    adapter: SessionAdapter;
+    env: FoirEnv;
+    /** Path the service worker is served from (must be same-origin). Default `/foir-sw.js`. */
+    swPath?: string;
+    /** Service-worker registration scope. Default `/`. */
+    scope?: string;
+    /** Optional label stored alongside the device token. */
+    deviceName?: string;
+}
+export type EnableWebPushResult = {
+    ok: true;
+    subscription: PushSubscription;
+} | {
+    ok: false;
+    reason: 'unsupported' | 'denied' | 'no-config';
+};
+export interface DisableWebPushOptions {
+    adapter: SessionAdapter;
+    env: FoirEnv;
+    /** Scope the service worker was registered with. Default `/`. */
+    scope?: string;
+}
+/** True when the current browser supports the Web Push APIs this helper needs. */
+export declare function isWebPushSupported(): boolean;
+/**
+ * Subscribe the current browser to Foir Web Push and register the subscription
+ * as a `WEB` device token. Idempotent: reuses an existing subscription when one
+ * is already present. Returns `{ ok: false }` (never throws) when the browser
+ * is unsupported or the user declines permission.
+ */
+export declare function enableWebPush(opts: EnableWebPushOptions): Promise<EnableWebPushResult>;
+/**
+ * Unsubscribe the current browser from Web Push and deregister the device
+ * token. Returns `false` when there was no active subscription to remove.
+ */
+export declare function disableWebPush(opts: DisableWebPushOptions): Promise<boolean>;