@iebh/tera-fy 2.0.21 → 2.2.0

package/dist/plugins/base.d.ts

@@ -0,0 +1,20 @@
+import type TeraFy from "../lib/terafy.client.ts";
+/**
+* Base TeraFy plugin interface
+* This is included as a documentation exanple only
+*
+* @class TeraFyPlugin
+*/
+export default class TeraFyPlugin {
+    /**
+    * Optional function to be included when the main TeraFyClient is initalized
+    */
+    init(): void;
+    /**
+    * Instance constructor
+    *
+    * @param {TeraFy} terafy The TeraFy client this plugin is being initalized against
+    * @param {Object} [options] Additional options to mutate behaviour
+    */
+    constructor(terafy: TeraFy, options: Object);
+}

package/dist/plugins/base.js

@@ -0,0 +1,21 @@
+/**
+* Base TeraFy plugin interface
+* This is included as a documentation exanple only
+*
+* @class TeraFyPlugin
+*/
+export default class TeraFyPlugin {
+    /**
+    * Optional function to be included when the main TeraFyClient is initalized
+    */
+    init() { }
+    /**
+    * Instance constructor
+    *
+    * @param {TeraFy} terafy The TeraFy client this plugin is being initalized against
+    * @param {Object} [options] Additional options to mutate behaviour
+    */
+    constructor(terafy, options) {
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/plugins/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../plugins/base.ts"],"names":[],"mappings":"AAEA;;;;;EAKE;AACF,MAAM,CAAC,OAAO,OAAO,YAAY;IAEhC;;MAEE;IACF,IAAI,KAAI,CAAC;IAGT;;;;;MAKE;IACF,YAAY,MAAc,EAAE,OAAe;IAC3C,CAAC;CACD"}

package/dist/plugins/firebase.d.ts

@@ -0,0 +1,62 @@
+import Syncro from '../lib/syncro/syncro.js';
+import TeraFyPluginBase from './base.js';
+/**
+* Plugin which adds Firebase / Firestore support for namespace mounts
+*
+* @class TeraFyPluginFirebase
+*/
+export default class TeraFyPluginFirebase extends TeraFyPluginBase {
+    /**
+    * Lookup object of mounted Syncro objects by path
+    *
+    * @type {Object<Syncro>}
+    */
+    syncros: Record<string, Syncro>;
+    namespaces: Record<string, any>;
+    getCredentials: () => Promise<Record<string, any>>;
+    requireProject: () => Promise<{
+        id: string;
+    }>;
+    debug: (...args: any[]) => void;
+    /**
+    * @interface
+    * The Syncro#reactive option to use when creating new Syncro instances
+    * This is expected to be overriden by other plugins
+    * If falsy the Syncro module will fall back to its internal (POJO only) getReactive() function
+    *
+    * @name getReactive
+    * @type {Function} A reactive function as defined in Syncro
+    */
+    getReactive?: Function;
+    /**
+    * Setup Firebase + Firestore + Supabase
+    * Default credentials (Firebase + Supabase) will be retrieved from `getCredentials()` unless overriden here
+    *
+    * @param {Object} options Additional options to mutate behaviour (defaults to the main teraFy settings)
+    * @param {String} [options.firebaseApiKey] Firebase API key
+    * @param {String} [options.firebaseAuthDomain] Firebase authorized domain
+    * @param {String} [options.firebaseProjectId] Firebase project ID
+    * @param {String} [options.firebaseAppId] Firebase App ID
+    * @param {String} [options.supabaseUrl] Supabase URL
+    * @param {String} [options.supabaseKey] Supabase client key
+    *
+    * @returns {Promise} A Promise which will resolve when the init process has completed
+    */
+    init(options?: any): Promise<void>;
+    /**
+    * Mount the given namespace against `namespaces[name]`
+    *
+    * @param {'_PROJECT'|String} name The name/Syncro path of the namespace to mount (or '_PROJECT' for the project mountpoint)
+    *
+    * @returns {Promise} A promise which resolves when the operation has completed
+    */
+    _mountNamespace(name: string): Promise<void>;
+    /**
+    * Unmount the given namespace from `namespaces[name]`
+    *
+    * @param {String} name The name/Syncro path of the namespace to unmount
+    *
+    * @returns {Promise} A promise which resolves when the operation has completed
+    */
+    _unmountNamespace(name: string): Promise<void | any[]>;
+}

package/dist/plugins/firebase.js

@@ -0,0 +1,111 @@
+import { initializeApp as Firebase } from 'firebase/app';
+import { getFirestore as Firestore } from 'firebase/firestore';
+import Supabasey from '@iebh/supabasey';
+import Syncro from '../lib/syncro/syncro.js';
+import TeraFyPluginBase from './base.js';
+/**
+* Plugin which adds Firebase / Firestore support for namespace mounts
+*
+* @class TeraFyPluginFirebase
+*/
+export default class TeraFyPluginFirebase extends TeraFyPluginBase {
+    constructor() {
+        super(...arguments);
+        /**
+        * Lookup object of mounted Syncro objects by path
+        *
+        * @type {Object<Syncro>}
+        */
+        this.syncros = {};
+        this.namespaces = {}; // Declare namespaces property
+    }
+    /**
+    * Setup Firebase + Firestore + Supabase
+    * Default credentials (Firebase + Supabase) will be retrieved from `getCredentials()` unless overriden here
+    *
+    * @param {Object} options Additional options to mutate behaviour (defaults to the main teraFy settings)
+    * @param {String} [options.firebaseApiKey] Firebase API key
+    * @param {String} [options.firebaseAuthDomain] Firebase authorized domain
+    * @param {String} [options.firebaseProjectId] Firebase project ID
+    * @param {String} [options.firebaseAppId] Firebase App ID
+    * @param {String} [options.supabaseUrl] Supabase URL
+    * @param {String} [options.supabaseKey] Supabase client key
+    *
+    * @returns {Promise} A Promise which will resolve when the init process has completed
+    */
+    async init(options) {
+        let settings = {
+            firebaseApiKey: null,
+            firebaseAuthDomain: null,
+            firebaseProjectId: null,
+            firebaseAppId: null,
+            supabaseUrl: null,
+            supabaseKey: null,
+            ...await this.getCredentials(),
+            ...options,
+        };
+        let emptyValues = Object.keys(settings).filter(k => k === null);
+        if (emptyValues.length > 0)
+            throw new Error('Firebase plugin requires mandatory options: ' + emptyValues.join(', '));
+        Syncro.firebase = Firebase({
+            apiKey: settings.firebaseApiKey, // Add non-null assertion
+            authDomain: settings.firebaseAuthDomain, // Add non-null assertion
+            projectId: settings.firebaseProjectId, // Add non-null assertion
+            appId: settings.firebaseAppId, // Add non-null assertion
+        });
+        Syncro.firestore = Firestore(Syncro.firebase); // Use Syncro.firebase
+        Syncro.supabasey = await Supabasey.init({
+            env: {
+                SUPABASE_URL: settings.supabaseUrl,
+                SUPABASE_KEY: settings.supabaseKey, // Add non-null assertions
+            },
+        });
+    }
+    /**
+    * Mount the given namespace against `namespaces[name]`
+    *
+    * @param {'_PROJECT'|String} name The name/Syncro path of the namespace to mount (or '_PROJECT' for the project mountpoint)
+    *
+    * @returns {Promise} A promise which resolves when the operation has completed
+    */
+    _mountNamespace(name) {
+        let syncro; // Add type Syncro
+        return Promise.resolve()
+            .then(() => this.requireProject())
+            .then(project => {
+            let path = name == '_PROJECT'
+                ? `projects::${project.id}`
+                : `project_namespaces::${project.id}::${name}`;
+            syncro = this.syncros[name] = new Syncro(path, {
+                debug: (...msg) => this.debug(`SYNCRO://${path}`, ...msg), // Add type any[]
+                getReactive: this.getReactive, // Try to inherit this instances getReactive prop, otherwise Syncro will fall back to its default
+            });
+            // Perform the mount action
+            return syncro.mount();
+        })
+            .then(() => {
+            this.namespaces[name] = syncro.value;
+        });
+    }
+    /**
+    * Unmount the given namespace from `namespaces[name]`
+    *
+    * @param {String} name The name/Syncro path of the namespace to unmount
+    *
+    * @returns {Promise} A promise which resolves when the operation has completed
+    */
+    _unmountNamespace(name) {
+        let syncro = this.syncros[name]; // Create local alias for Syncro before we detach it
+        // Detach local state
+        delete this.namespaces[name];
+        delete this.syncros[name];
+        // Check if syncro exists before calling destroy
+        if (syncro) {
+            return syncro.destroy(); // Trigger Syncro distruction
+        }
+        else {
+            return Promise.resolve(); // Or handle the case where syncro doesn't exist
+        }
+    }
+}
+//# sourceMappingURL=firebase.js.map

package/dist/plugins/firebase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../../plugins/firebase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,IAAI,QAAQ,EAAc,MAAM,cAAc,CAAC;AACpE,OAAO,EAAC,YAAY,IAAI,SAAS,EAAiC,MAAM,oBAAoB,CAAC;AAC7F,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,MAAM,MAAM,yBAAyB,CAAC;AAC7C,OAAO,gBAAgB,MAAM,WAAW,CAAC;AAGzC;;;;EAIE;AACF,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,gBAAgB;IAAlE;;QAEC;;;;UAIE;QACF,YAAO,GAA2B,EAAE,CAAC;QACrC,eAAU,GAAwB,EAAE,CAAC,CAAC,8BAA8B;IAuHrE,CAAC;IAnGA;;;;;;;;;;;;;MAaE;IACF,KAAK,CAAC,IAAI,CAAC,OAAa;QACvB,IAAI,QAAQ,GAAG;YACd,cAAc,EAAE,IAAI;YACpB,kBAAkB,EAAE,IAAI;YACxB,iBAAiB,EAAE,IAAI;YACvB,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,IAAI;YACjB,WAAW,EAAE,IAAI;YACjB,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE;YAC9B,GAAG,OAAO;SACV,CAAC;QAEF,IAAI,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QAChE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1F,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC1B,MAAM,EAAE,QAAQ,CAAC,cAAe,EAAE,yBAAyB;YAC3D,UAAU,EAAE,QAAQ,CAAC,kBAAmB,EAAE,yBAAyB;YACnE,SAAS,EAAE,QAAQ,CAAC,iBAAkB,EAAE,yBAAyB;YACjE,KAAK,EAAE,QAAQ,CAAC,aAAc,EAAE,yBAAyB;SACzD,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,sBAAsB;QAErE,MAAM,CAAC,SAAS,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YACvC,GAAG,EAAE;gBACJ,YAAY,EAAE,QAAQ,CAAC,WAAY;gBACnC,YAAY,EAAE,QAAQ,CAAC,WAAY,EAAE,0BAA0B;aAC/D;SACD,CAAC,CAAC;IACJ,CAAC;IAGD;;;;;;MAME;IACF,eAAe,CAAC,IAAY;QAC3B,IAAI,MAAc,CAAC,CAAC,kBAAkB;QAEtC,OAAO,OAAO,CAAC,OAAO,EAAE;aACtB,IAAI,CAAC,GAAE,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;aAChC,IAAI,CAAC,OAAO,CAAC,EAAE;YACf,IAAI,IAAI,GAAG,IAAI,IAAI,UAAU;gBAC5B,CAAC,CAAC,aAAa,OAAO,CAAC,EAAE,EAAE;gBAC3B,CAAC,CAAC,uBAAuB,OAAO,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;YAEhD,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE;gBAC9C,KAAK,EAAE,CAAC,GAAG,GAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC,EAAE,iBAAiB;gBACnF,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,iGAAiG;aAChI,CAAC,CAAC;YAEH,2BAA2B;YAC3B,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;aACD,IAAI,CAAC,GAAE,EAAE;YACT,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACtC,CAAC,CAAC,CAAA;IACJ,CAAC;IAGD;;;;;;MAME;IACF,iBAAiB,CAAC,IAAY;QAC7B,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,oDAAoD;QAErF,qBAAqB;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE1B,gDAAgD;QAChD,IAAI,MAAM,EAAE,CAAC;YACZ,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,6BAA6B;QACvD,CAAC;aAAM,CAAC;YACP,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,gDAAgD;QAC3E,CAAC;IACF,CAAC;CACD"}

package/dist/plugins/vite.d.ts

@@ -0,0 +1,12 @@
+/**
+* Setup a Vite local loopback
+*
+* @see lib/terafy.proxy.js
+*
+* @param {Object} [options] Options to pass to the Proxy module
+* @returns {VitePlugin}
+*/
+export default function vitePluginTeraFy(options: any): {
+    name: string;
+    apply(config: any, { command }: any): false | undefined;
+};

package/dist/plugins/vite.js

@@ -0,0 +1,22 @@
+import TeraProxy from '../lib/terafy.proxy.js';
+/**
+* Setup a Vite local loopback
+*
+* @see lib/terafy.proxy.js
+*
+* @param {Object} [options] Options to pass to the Proxy module
+* @returns {VitePlugin}
+*/
+export default function vitePluginTeraFy(options) {
+    // Vite plugin config
+    return {
+        name: 'tera-fy',
+        apply(config, { command }) {
+            // Don't run when building
+            if (command == 'build')
+                return false;
+            TeraProxy(options);
+        },
+    };
+}
+//# sourceMappingURL=vite.js.map

package/dist/plugins/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","sourceRoot":"","sources":["../../plugins/vite.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAE/C;;;;;;;EAOE;AACF,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAY;IAEpD,qBAAqB;IACrB,OAAO;QACN,IAAI,EAAE,SAAS;QACf,KAAK,CAAC,MAAW,EAAE,EAAE,OAAO,EAAO;YAElC,0BAA0B;YAC1B,IAAI,OAAO,IAAI,OAAO;gBAAE,OAAO,KAAK,CAAC;YAErC,SAAS,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;KACD,CAAA;AACF,CAAC"}

package/dist/plugins/vue2.d.ts

@@ -0,0 +1,68 @@
+import TeraFyPluginFirebase from './firebase.js';
+/**
+* Vue@2 observables plugin
+*
+* This function is expected to be included via the `terafy.use(MODULE, OPTIONS)` syntax rather than directly
+*
+* @class TeraFyPluginVue2
+*
+* @example Implementation within a Vue@2 project `src/main.js`:
+* // Include the main Tera-Fy core
+* import TeraFy from '@iebh/tera-fy';
+* import TerafyVue from '@iebh/tera-fy/plugins/vue2';
+* let terafy = new TeraFy()
+*   .set('devMode', true) // Uncomment this line if you want TeraFy to be chatty
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
+*   .use(TerafyVue, { // Add the Vue plugin
+*   	vue: window.Vue, // Assumes Vue is available on the window object
+*   })
+*
+* // Include after app boot
+* const app = new Vue({ ... })
+* app.$mount("#app");
+* await terafy.init({app});
+*/
+export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
+    /**
+    * Local Vue@2 library to use, set during constuctor
+    *
+    * @type {Vue}
+    */
+    Vue: any;
+    /**
+    * The root Vue app instance
+    * @type {any}
+    */
+    app: any;
+    /**
+    * The bound, reactive state of the active TERA project
+    *
+    * @type {Object | null}
+    */
+    project: any;
+    /**
+    * Simple incrementor to ensure unique IDs for $watch expressions
+    *
+    * @type {Number}
+    */
+    reactiveId: number;
+    /**
+    * Install into Vue@2
+    *
+    * @param {Object} options Additional options to mutate behaviour, see TeraFyPluginFirebase
+    * @param {Object} options.app Root level Vue app to bind against
+    * @param {Vue} options.Vue Vue@2 instance to bind against
+    * @param {String} [options.globalName='$tera'] Global property to allocate this service as within Vue2
+    * @param {*...} [options...] see TeraFyPluginFirebase
+    *
+    * @returns {Promise} A Promise which will resolve when the init process has completed
+    */
+    init(options: any): Promise<void>;
+    /** @override */
+    getReactive(value: any): {
+        doc: any;
+        setState: (state: any) => void;
+        getState: () => any;
+        watch: (cb: Function) => void;
+    };
+}

package/dist/plugins/vue2.js

@@ -0,0 +1,96 @@
+import { cloneDeep, isEqual } from 'lodash-es';
+import TeraFyPluginFirebase from './firebase.js';
+/**
+* Vue@2 observables plugin
+*
+* This function is expected to be included via the `terafy.use(MODULE, OPTIONS)` syntax rather than directly
+*
+* @class TeraFyPluginVue2
+*
+* @example Implementation within a Vue@2 project `src/main.js`:
+* // Include the main Tera-Fy core
+* import TeraFy from '@iebh/tera-fy';
+* import TerafyVue from '@iebh/tera-fy/plugins/vue2';
+* let terafy = new TeraFy()
+*   .set('devMode', true) // Uncomment this line if you want TeraFy to be chatty
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
+*   .use(TerafyVue, { // Add the Vue plugin
+*   	vue: window.Vue, // Assumes Vue is available on the window object
+*   })
+*
+* // Include after app boot
+* const app = new Vue({ ... })
+* app.$mount("#app");
+* await terafy.init({app});
+*/
+export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
+    constructor() {
+        super(...arguments);
+        /**
+        * The bound, reactive state of the active TERA project
+        *
+        * @type {Object | null}
+        */
+        this.project = null;
+        /**
+        * Simple incrementor to ensure unique IDs for $watch expressions
+        *
+        * @type {Number}
+        */
+        this.reactiveId = 1001;
+    }
+    /**
+    * Install into Vue@2
+    *
+    * @param {Object} options Additional options to mutate behaviour, see TeraFyPluginFirebase
+    * @param {Object} options.app Root level Vue app to bind against
+    * @param {Vue} options.Vue Vue@2 instance to bind against
+    * @param {String} [options.globalName='$tera'] Global property to allocate this service as within Vue2
+    * @param {*...} [options...] see TeraFyPluginFirebase
+    *
+    * @returns {Promise} A Promise which will resolve when the init process has completed
+    */
+    async init(options) {
+        let settings = {
+            app: null,
+            Vue: null,
+            globalName: '$tera',
+            ...options,
+        };
+        if (!settings.Vue)
+            throw new Error('Vue instance to use must be specified in init options as `Vue`');
+        this.Vue = settings.Vue;
+        if (!settings.app)
+            throw new Error('Vue Root / App instance to use must be specified in init options as `app`');
+        this.app = settings.app;
+        // Make this module available globally
+        if (settings.globalName)
+            this.Vue.prototype[settings.globalName] = this;
+        await super.init(settings); // Initalize parent class Firebase functionality
+        // @ts-ignore
+        this.project = await this.mountNamespace('_PROJECT');
+    }
+    /** @override */
+    // @ts-ignore
+    getReactive(value) {
+        let doc = this.Vue.observable(value);
+        let watcherPath = `_teraFy_${this.reactiveId++}`;
+        this.app[watcherPath] = doc; // Attach onto app so we can use $watch later on
+        return {
+            doc,
+            setState: (state) => {
+                // Shallow copy all sub-keys into existing object (keeping the object pointer)
+                Object.entries(state || {})
+                    .filter(([k]) => !isEqual(doc[k], state[k])) // Only accept changed keys
+                    .forEach(([k, v]) => doc[k] = v);
+            },
+            getState: () => {
+                return cloneDeep(doc);
+            },
+            watch: (cb) => {
+                this.app.$watch(watcherPath, cb, { deep: true });
+            },
+        };
+    }
+}
+//# sourceMappingURL=vue2.js.map

package/dist/plugins/vue2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue2.js","sourceRoot":"","sources":["../../plugins/vue2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAE,OAAO,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,oBAAoB,MAAM,eAAe,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;EAsBE;AACF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,oBAAoB;IAAlE;;QAgBC;;;;UAIE;QACF,YAAO,GAAQ,IAAI,CAAC;QAGpB;;;;UAIE;QACF,eAAU,GAAG,IAAI,CAAC;IA+DnB,CAAC;IA5DA;;;;;;;;;;MAUE;IACF,KAAK,CAAC,IAAI,CAAC,OAAY;QACtB,IAAI,QAAQ,GAAG;YACd,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI;YACT,UAAU,EAAE,OAAO;YACnB,GAAG,OAAO;SACV,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACrG,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QAExB,IAAI,CAAC,QAAQ,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QAChH,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QAExB,sCAAsC;QACtC,IAAI,QAAQ,CAAC,UAAU;YACtB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAEhD,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,gDAAgD;QAC5E,aAAa;QACb,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IAGD,gBAAgB;IAChB,aAAa;IACb,WAAW,CAAC,KAAU;QACrB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAErC,IAAI,WAAW,GAAG,WAAW,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACjD,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,GAAG,CAAC,CAAC,gDAAgD;QAE7E,OAAO;YACN,GAAG;YACH,QAAQ,EAAE,CAAC,KAAU,EAAE,EAAE;gBACxB,8EAA8E;gBAC9E,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;qBACzB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,2BAA2B;qBACvE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,QAAQ,EAAE,GAAG,EAAE;gBACd,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;YACD,KAAK,EAAE,CAAC,EAAY,EAAE,EAAE;gBACvB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;YAChD,CAAC;SACD,CAAC;IACH,CAAC;CAED"}

package/dist/plugins/vue3.d.ts

@@ -0,0 +1,64 @@
+import TeraFyPluginFirebase from './firebase.js';
+import { App, WatchCallback } from 'vue';
+/**
+* Vue observables plugin
+*
+* This function is expected to be included via the `terafy.use(MODULE, OPTIONS)` syntax rather than directly
+*
+* @class TeraFyPluginVue3
+*
+* @example Implementation within a Vue3 / Vite project within `src/main.js`:
+* import TeraFy from '@iebh/tera-fy';
+* import TerafyVue from '@iebh/tera-fy/plugins/vue';
+* let terafy = new TeraFy()
+*   .set('devMode', import.meta.env.DEV)
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
+*   .use(TerafyVue) // Add the Vue plugin
+*
+* terafy.init(); // Initialize everything
+*
+* app.use(terafy.vuePlugin({
+*   globalName: '$tera', // Install as vm.$tera into every component
+* }));
+*
+* @example Accessing project state - within a Vue component
+* this.$tera.active
+*/
+export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
+    /**
+    * The bound, reactive state of the active TERA project
+    *
+    * @type {Object}
+    */
+    project: any;
+    /**
+    * Init the project including create a reactive mount for the active project
+    *
+    * @param {Object} options Additional options to mutate behaviour
+    * @param {*} [options...] see TeraFyPluginFirebase
+    */
+    init(options: Record<string, any>): Promise<void>;
+    /** @override */
+    getReactive(value: any): {
+        doc: any;
+        setState(state: any): void;
+        getState(): any;
+        watch(cb: WatchCallback<any, any>): void;
+    };
+    /**
+    * Provide a Vue@3 compatible plugin
+    *
+    * @returns {VuePlugin} A Vue@3 plugin spec
+    */
+    vuePlugin(): {
+        /**
+        * Install into Vue as a generic Vue@3 plugin
+        *
+        * @param {VueApp} app The Vue top-level app to install against
+        *
+        * @param {Object} [options] Additional options to mutate behaviour
+        * @param {String} [options.globalName='$tera'] Global property to allocate this service as
+        */
+        install(app: App, options: Record<string, any>): void;
+    };
+}

package/dist/plugins/vue3.js

@@ -0,0 +1,96 @@
+import { cloneDeep } from 'lodash-es';
+import TeraFyPluginFirebase from './firebase.js';
+import { reactive as vueReactive, watch as vueWatch } from 'vue';
+/**
+* Vue observables plugin
+*
+* This function is expected to be included via the `terafy.use(MODULE, OPTIONS)` syntax rather than directly
+*
+* @class TeraFyPluginVue3
+*
+* @example Implementation within a Vue3 / Vite project within `src/main.js`:
+* import TeraFy from '@iebh/tera-fy';
+* import TerafyVue from '@iebh/tera-fy/plugins/vue';
+* let terafy = new TeraFy()
+*   .set('devMode', import.meta.env.DEV)
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
+*   .use(TerafyVue) // Add the Vue plugin
+*
+* terafy.init(); // Initialize everything
+*
+* app.use(terafy.vuePlugin({
+*   globalName: '$tera', // Install as vm.$tera into every component
+* }));
+*
+* @example Accessing project state - within a Vue component
+* this.$tera.active
+*/
+export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
+    constructor() {
+        super(...arguments);
+        /**
+        * The bound, reactive state of the active TERA project
+        *
+        * @type {Object}
+        */
+        this.project = null;
+    }
+    /**
+    * Init the project including create a reactive mount for the active project
+    *
+    * @param {Object} options Additional options to mutate behaviour
+    * @param {*} [options...] see TeraFyPluginFirebase
+    */
+    async init(options) {
+        await super.init(options); // Initalize parent class Firebase functionality
+        // Mount the project namespace
+        // @ts-ignore
+        this.project = await this.mountNamespace('_PROJECT');
+    }
+    /** @override */
+    // @ts-ignore
+    getReactive(value) {
+        let doc = vueReactive(value);
+        return {
+            doc,
+            setState(state) {
+                // Shallow copy all sub-keys into existing object (keeping the object pointer)
+                Object.entries(state || {})
+                    .forEach(([k, v]) => doc[k] = v);
+            },
+            getState() {
+                return cloneDeep(doc);
+            },
+            watch(cb) {
+                vueWatch(doc, cb, { deep: true });
+            },
+        };
+    }
+    /**
+    * Provide a Vue@3 compatible plugin
+    *
+    * @returns {VuePlugin} A Vue@3 plugin spec
+    */
+    vuePlugin() {
+        let $tera = this;
+        return {
+            /**
+            * Install into Vue as a generic Vue@3 plugin
+            *
+            * @param {VueApp} app The Vue top-level app to install against
+            *
+            * @param {Object} [options] Additional options to mutate behaviour
+            * @param {String} [options.globalName='$tera'] Global property to allocate this service as
+            */
+            install(app, options) {
+                let settings = {
+                    globalName: '$tera',
+                    ...options,
+                };
+                // Make this module available globally
+                app.config.globalProperties[settings.globalName] = $tera;
+            },
+        };
+    }
+}
+//# sourceMappingURL=vue3.js.map

package/dist/plugins/vue3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue3.js","sourceRoot":"","sources":["../../plugins/vue3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,oBAAoB,MAAM,eAAe,CAAC;AACjD,OAAO,EAAC,QAAQ,IAAI,WAAW,EAAE,KAAK,IAAI,QAAQ,EAAqB,MAAM,KAAK,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;EAuBE;AACF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,oBAAoB;IAAlE;;QAEC;;;;UAIE;QACF,YAAO,GAAQ,IAAI,CAAC;IAsErB,CAAC;IAnEA;;;;;MAKE;IACF,KAAK,CAAC,IAAI,CAAC,OAA4B;QACtC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,gDAAgD;QAE3E,8BAA8B;QAC9B,aAAa;QACb,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IAGD,gBAAgB;IAChB,aAAa;IACb,WAAW,CAAC,KAAU;QACrB,IAAI,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO;YACN,GAAG;YACH,QAAQ,CAAC,KAAU;gBAClB,8EAA8E;gBAC9E,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;qBACzB,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,QAAQ;gBACP,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;YACD,KAAK,CAAC,EAA2B;gBAChC,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;YACjC,CAAC;SACD,CAAC;IACH,CAAC;IAGD;;;;MAIE;IACF,SAAS;QACR,IAAI,KAAK,GAAG,IAAI,CAAC;QAEjB,OAAO;YAEN;;;;;;;cAOE;YACF,OAAO,CAAC,GAAQ,EAAE,OAA4B;gBAC7C,IAAI,QAAQ,GAAG;oBACd,UAAU,EAAE,OAAO;oBACnB,GAAG,OAAO;iBACV,CAAC;gBAEF,sCAAsC;gBACtC,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;YAC1D,CAAC;SAED,CAAC;IACH,CAAC;CAED"}