@egen-civitas/esm-platform 0.0.0-stage → 1.2.0

package/dist/native-platform.test.js

@@ -0,0 +1,329 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    }, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype), d = Object.defineProperty;
+    return d(g, "next", {
+        value: verb(0)
+    }), d(g, "throw", {
+        value: verb(1)
+    }), d(g, "return", {
+        value: verb(2)
+    }), typeof Symbol === "function" && d(g, Symbol.iterator, {
+        value: function() {
+            return this;
+        }
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(g && (g = 0, op[0] && (_ = 0)), _)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { afterEach, describe, expect, it } from 'vitest';
+import { getHostInfo, getPlatform, registerPlatformCapabilities } from './index';
+import { createMockHost } from './testing';
+afterEach(function() {
+    var w = window;
+    delete w.egenTarget;
+    delete w.egenHostBridge;
+});
+describe('getPlatform() natif — handshake avec le Host', function() {
+    it('ready attend le handshake ; getHostInfo() expose ce que le Host a annoncé', function() {
+        return _async_to_generator(function() {
+            var host;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'android';
+                        host = createMockHost({
+                            host: '4.2.0',
+                            capabilities: {
+                                secureStorage: {
+                                    v: 1
+                                }
+                            }
+                        });
+                        host.install();
+                        expect(getHostInfo()).toBeNull(); // pas encore de handshake
+                        return [
+                            4,
+                            getPlatform().ready
+                        ];
+                    case 1:
+                        _state.sent();
+                        expect(getHostInfo()).toEqual({
+                            protocol: 1,
+                            host: '4.2.0',
+                            platform: 'android',
+                            capabilities: {
+                                secureStorage: {
+                                    v: 1
+                                }
+                            }
+                        });
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    it('plusieurs getPlatform() partagent UN SEUL handshake et UN SEUL abonnement', function() {
+        return _async_to_generator(function() {
+            var host;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'android';
+                        host = createMockHost();
+                        host.install();
+                        return [
+                            4,
+                            Promise.all([
+                                getPlatform().ready,
+                                getPlatform().ready,
+                                getPlatform().ready
+                            ])
+                        ];
+                    case 1:
+                        _state.sent();
+                        return [
+                            4,
+                            getPlatform().ready
+                        ];
+                    case 2:
+                        _state.sent();
+                        expect(host.sent.filter(function(r) {
+                            return r.m === 'hello';
+                        })).toHaveLength(1);
+                        expect(host.subscribeCount).toBe(1);
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    it('Host de version de protocole incompatible ⇒ ready rejette INCOMPATIBLE', function() {
+        return _async_to_generator(function() {
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'ios';
+                        createMockHost({
+                            platform: 'ios',
+                            protocol: 2
+                        }).install();
+                        return [
+                            4,
+                            expect(getPlatform().ready).rejects.toMatchObject({
+                                code: 'INCOMPATIBLE'
+                            })
+                        ];
+                    case 1:
+                        _state.sent();
+                        expect(getHostInfo()).toBeNull();
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    it('Host qui annonce une autre plateforme que la cible du build ⇒ INCOMPATIBLE', function() {
+        return _async_to_generator(function() {
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'ios';
+                        createMockHost({
+                            platform: 'android'
+                        }).install();
+                        return [
+                            4,
+                            expect(getPlatform().ready).rejects.toMatchObject({
+                                code: 'INCOMPATIBLE'
+                            })
+                        ];
+                    case 1:
+                        _state.sent();
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    it("tant que les adaptateurs natifs (C7) n'existent pas, aucune capacité n'est disponible — même annoncée par le Host", function() {
+        return _async_to_generator(function() {
+            var platform;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'android';
+                        createMockHost({
+                            capabilities: {
+                                secureStorage: {
+                                    v: 1
+                                },
+                                session: {
+                                    v: 1
+                                }
+                            }
+                        }).install();
+                        platform = getPlatform();
+                        return [
+                            4,
+                            platform.ready
+                        ];
+                    case 1:
+                        _state.sent();
+                        expect(platform.has('secureStorage')).toBe(false);
+                        return [
+                            4,
+                            expect(platform.secureStorage.get('k')).rejects.toMatchObject({
+                                code: 'UNAVAILABLE'
+                            })
+                        ];
+                    case 2:
+                        _state.sent();
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    it('registerPlatformCapabilities() attend le handshake natif', function() {
+        return _async_to_generator(function() {
+            var host;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        window.egenTarget = 'android';
+                        host = createMockHost();
+                        host.install();
+                        return [
+                            4,
+                            expect(registerPlatformCapabilities()).resolves.toBeUndefined()
+                        ];
+                    case 1:
+                        _state.sent();
+                        expect(host.sent.some(function(r) {
+                            return r.m === 'hello';
+                        })).toBe(true);
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+});

package/dist/native.d.ts

@@ -0,0 +1,24 @@
+import { type BridgeClient, type HostInfo } from './bridge/client.js';
+import type { HostBridge } from './bridge/protocol.js';
+import type { CapabilityOverrides } from './capabilities.js';
+import type { PlatformEnvironment } from './types.js';
+/**
+ * Client du pont donné. `getPlatform()` est appelé plusieurs fois (démarrage, apps) : sans ce partage, chaque appel
+ * referait un `subscribe` et un handshake. Un seul client par pont ⇒ un seul handshake (`hello()` est mémorisé : une
+ * incompatibilité reste rejetée, un échec passager comme un timeout peut être rejoué).
+ */
+export declare function getNativeClient(bridge: HostBridge, environment: PlatformEnvironment): BridgeClient;
+/**
+ * Capacités natives implémentées par le framework, branchées sur le client de pont : celles dont l'entrée du registre
+ * (`registry.ts`) déclare un adaptateur `native`. AUCUNE tant que les adaptateurs natifs (tâche C7) ne sont pas écrits :
+ * `has()` reste faux partout, même si le Host annonce la capacité — on ne promet jamais ce que le framework ne sait
+ * pas encore appeler.
+ */
+export declare function createNativeCapabilities(client: BridgeClient): CapabilityOverrides;
+/**
+ * Ce que le Host a annoncé au handshake (version de protocole, version du Host, capacités), ou `null` si le
+ * handshake n'a pas (encore) réussi. Utile au diagnostic et à la validation de compatibilité.
+ *
+ * @category Platform
+ */
+export declare function getHostInfo(): HostInfo | null;

package/dist/native.js

@@ -0,0 +1,46 @@
+import { createBridgeClient } from './bridge/client.js';
+import { getHostBridge } from './detect.js';
+import { createNativeCapabilitiesFromRegistry } from './registry.js';
+/** Un client de pont par pont : ses abonnements et son handshake sont partagés par tous les `getPlatform()` de la page. */
+const clients = new WeakMap();
+function frameworkVersion() {
+    try {
+        // Remplacé à la compilation par le DefinePlugin du shell ; absent (ReferenceError) hors bundle.
+        return process.env.FRAMEWORK_VERSION || undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Client du pont donné. `getPlatform()` est appelé plusieurs fois (démarrage, apps) : sans ce partage, chaque appel
+ * referait un `subscribe` et un handshake. Un seul client par pont ⇒ un seul handshake (`hello()` est mémorisé : une
+ * incompatibilité reste rejetée, un échec passager comme un timeout peut être rejoué).
+ */
+export function getNativeClient(bridge, environment) {
+    let client = clients.get(bridge);
+    if (!client) {
+        client = createBridgeClient({ bridge, environment, framework: frameworkVersion() });
+        clients.set(bridge, client);
+    }
+    return client;
+}
+/**
+ * Capacités natives implémentées par le framework, branchées sur le client de pont : celles dont l'entrée du registre
+ * (`registry.ts`) déclare un adaptateur `native`. AUCUNE tant que les adaptateurs natifs (tâche C7) ne sont pas écrits :
+ * `has()` reste faux partout, même si le Host annonce la capacité — on ne promet jamais ce que le framework ne sait
+ * pas encore appeler.
+ */
+export function createNativeCapabilities(client) {
+    return createNativeCapabilitiesFromRegistry(client);
+}
+/**
+ * Ce que le Host a annoncé au handshake (version de protocole, version du Host, capacités), ou `null` si le
+ * handshake n'a pas (encore) réussi. Utile au diagnostic et à la validation de compatibilité.
+ *
+ * @category Platform
+ */
+export function getHostInfo() {
+    const bridge = getHostBridge();
+    return bridge ? (clients.get(bridge)?.hostInfo ?? null) : null;
+}

package/dist/platform.d.ts

@@ -0,0 +1,24 @@
+import type { Platform } from './types.js';
+/**
+ * Point d'accès unique des apps aux capacités de plateforme.
+ *
+ * La cible est fixée au build (`window.egenTarget`).
+ * - Web : capacités du navigateur (adaptateur C4), rien à attendre.
+ * - Natif : le Host DOIT avoir injecté `window.egenHostBridge` avant tout script de la page, sinon `ready` rejette
+ *   `INCOMPATIBLE` (« Host manquant »). `ready` est le handshake de protocole (version, plateforme, capacités). Une
+ *   capacité n'est disponible que si le Host l'annonce ET que le framework sait l'appeler : tant que les adaptateurs
+ *   natifs (C7) ne sont pas écrits, `has()` est faux partout et chaque méthode rejette `UNAVAILABLE`.
+ *
+ * @category Platform
+ */
+export declare function getPlatform(): Platform;
+/**
+ * Rend les capacités de la plateforme consultables par le reste du framework (filtrage `requiredCapabilities`
+ * des apps, F2) et retourne `platform.ready`.
+ *
+ * À appeler UNE fois au démarrage, AVANT l'enregistrement des apps. Le résolveur est posé immédiatement : si `ready`
+ * rejette (natif sans Host), `has()` reste faux partout — aucune capacité n'est jamais supposée.
+ *
+ * @category Platform
+ */
+export declare function registerPlatformCapabilities(platform?: Platform): Promise<void>;

package/dist/platform.js

@@ -0,0 +1,56 @@
+import { setCapabilityResolver } from '@egen-civitas/esm-globals';
+import { assemblePlatform } from './capabilities.js';
+import { getHostBridge, getPlatformEnvironment } from './detect.js';
+import { PlatformError } from './errors.js';
+import { createNativeCapabilities, getNativeClient } from './native.js';
+import { createWebCapabilities, isHostVersionSufficient } from './registry.js';
+function hostMissing(environment) {
+    return new PlatformError('INCOMPATIBLE', `Host manquant : la cible "${environment}" exige que l'application hôte injecte window.egenHostBridge avant le chargement de la page.`);
+}
+/**
+ * Point d'accès unique des apps aux capacités de plateforme.
+ *
+ * La cible est fixée au build (`window.egenTarget`).
+ * - Web : capacités du navigateur (adaptateur C4), rien à attendre.
+ * - Natif : le Host DOIT avoir injecté `window.egenHostBridge` avant tout script de la page, sinon `ready` rejette
+ *   `INCOMPATIBLE` (« Host manquant »). `ready` est le handshake de protocole (version, plateforme, capacités). Une
+ *   capacité n'est disponible que si le Host l'annonce ET que le framework sait l'appeler : tant que les adaptateurs
+ *   natifs (C7) ne sont pas écrits, `has()` est faux partout et chaque méthode rejette `UNAVAILABLE`.
+ *
+ * @category Platform
+ */
+export function getPlatform() {
+    const environment = getPlatformEnvironment();
+    if (environment === 'web') {
+        return assemblePlatform({
+            environment,
+            capabilities: createWebCapabilities(),
+            ready: () => Promise.resolve(),
+        });
+    }
+    const bridge = getHostBridge();
+    if (!bridge) {
+        return assemblePlatform({ environment, ready: () => Promise.reject(hostMissing(environment)) });
+    }
+    const client = getNativeClient(bridge, environment);
+    return assemblePlatform({
+        environment,
+        capabilities: createNativeCapabilities(client),
+        ready: () => client.hello().then(() => undefined),
+        // Annoncée par le Host ET dans une version suffisante pour l'adaptateur de ce framework (registre).
+        available: (capability) => isHostVersionSufficient(capability, client.hostInfo?.capabilities[capability]?.v),
+    });
+}
+/**
+ * Rend les capacités de la plateforme consultables par le reste du framework (filtrage `requiredCapabilities`
+ * des apps, F2) et retourne `platform.ready`.
+ *
+ * À appeler UNE fois au démarrage, AVANT l'enregistrement des apps. Le résolveur est posé immédiatement : si `ready`
+ * rejette (natif sans Host), `has()` reste faux partout — aucune capacité n'est jamais supposée.
+ *
+ * @category Platform
+ */
+export function registerPlatformCapabilities(platform = getPlatform()) {
+    setCapabilityResolver((capability) => platform.has(capability));
+    return platform.ready;
+}