@inploi/plugin-accessibility 1.0.0

package/cdn/index.js

@@ -0,0 +1,3 @@
+// This is an inploi sdk script. Learn more at https://inploi.com 
+
+"use strict";(()=>{var D=(e,{pure_createActions:i})=>({pluginName:e,pure_createActions:i});var s="inploi-a11y";var j={getCurrentScript:()=>{let e=document.getElementById(s);if(!e)return null;if(!(e instanceof HTMLScriptElement))throw new Error(`Element with id ${s} is not a script tag.`);return e},getScriptLocation:()=>{var e;return(e=document.querySelector("head"))!=null?e:document.body},createScript:e=>{let i=document.createElement("script");return i.id=s,i.src="https://acsbapp.com/apps/app/dist/js/app.js",i.async=!0,i.onload=function(){var t,n,r,o,a,c,l,p,g,u,d,b,f,y,m,h,P,w,A,v,C,S,x,E,I,T;window.acsbJS.init({statementLink:"",footerHtml:"Powered by inploi",hideMobile:!1,hideTrigger:e.showTrigger===!1,disableBgProcess:!1,language:(t=e.language)!=null?t:"en",position:(o=(r=(n=e.position)==null?void 0:n.x)==null?void 0:r.desktop)!=null?o:"right",leadColor:e.colors.interface,triggerColor:e.colors.trigger,triggerRadius:"50%",triggerPositionX:(l=(c=(a=e.position)==null?void 0:a.x)==null?void 0:c.desktop)!=null?l:"right",triggerPositionY:(u=(g=(p=e.position)==null?void 0:p.y)==null?void 0:g.desktop)!=null?u:"bottom",triggerIcon:"people",triggerSize:"medium",triggerOffsetX:(b=(d=e.position)==null?void 0:d.offsetX)==null?void 0:b.desktop,triggerOffsetY:(y=(f=e.position)==null?void 0:f.offsetY)==null?void 0:y.desktop,mobile:{triggerSize:"small",triggerPositionX:(P=(h=(m=e.position)==null?void 0:m.x)==null?void 0:h.mobile)!=null?P:"right",triggerPositionY:(v=(A=(w=e.position)==null?void 0:w.y)==null?void 0:A.mobile)!=null?v:"bottom",triggerOffsetX:(x=(S=(C=e.position)==null?void 0:C.offsetX)==null?void 0:S.mobile)!=null?x:4,triggerOffsetY:(T=(I=(E=e.position)==null?void 0:E.offsetY)==null?void 0:I.mobile)!=null?T:4,triggerRadius:"20"}})},i}},L=({logger:e,config:i,dom:t})=>{if(!(typeof window=="undefined"||t.getCurrentScript()!==null))try{let r=t.getScriptLocation(),o=t.createScript(i);r.appendChild(o),e==null||e.info("Accessibility plugin initialised")}catch(r){e==null||e.error("Accessibility plugin failed to initialise",r)}},O=e=>D("accessibility",{pure_createActions:({logger:i})=>({initialise:()=>L({logger:i,config:e,dom:j})})});if(!window.inploi)throw new Error("Please insert the SDK script tag above the plugins.");window.inploi.createAccessibilityPlugin=O;})();

package/dist/index.d.mts

@@ -0,0 +1,72 @@
+import { Logger } from '@inploi/sdk';
+
+type AccessibeSize = 'small' | 'medium' | 'big';
+type HorizontalPosition = 'left' | 'right';
+type VerticalPosition = 'top' | 'center' | 'bottom';
+type AccessibilityPluginLanguage = 'en' | 'es' | 'fr' | 'de' | 'pl' | 'it' | 'pt' | 'nl' | 'hu' | 'sl' | 'sk' | 'cs' | 'tr' | 'ja' | 'tw' | 'zh' | 'he' | 'ru' | 'ar';
+type AccessibeParams = {
+    statementLink: string;
+    footerHtml: string;
+    hideMobile: boolean;
+    hideTrigger: boolean;
+    disableBgProcess: boolean;
+    language: AccessibilityPluginLanguage;
+    position: HorizontalPosition;
+    leadColor: string;
+    triggerColor: string;
+    triggerRadius: string;
+    triggerPositionX: HorizontalPosition;
+    triggerPositionY: VerticalPosition;
+    triggerIcon: string;
+    triggerSize: AccessibeSize;
+    triggerOffsetX: number | undefined;
+    triggerOffsetY: number | undefined;
+    mobile: {
+        triggerSize: AccessibeSize;
+        triggerPositionX: HorizontalPosition;
+        triggerPositionY: VerticalPosition;
+        triggerOffsetX: number;
+        triggerOffsetY: number;
+        triggerRadius: string;
+    };
+};
+declare global {
+    interface Window {
+        acsbJS: {
+            init: (params: AccessibeParams) => void;
+        };
+    }
+}
+
+type Responsive<T> = {
+    mobile: T;
+    desktop: T;
+};
+type AccessibilityWidgetConfig = {
+    language?: AccessibilityPluginLanguage;
+    colors: {
+        interface: string;
+        trigger: string;
+    };
+    showTrigger?: boolean;
+    position?: {
+        x?: Responsive<HorizontalPosition>;
+        y?: Responsive<VerticalPosition>;
+        offsetX?: Responsive<number>;
+        offsetY?: Responsive<number>;
+    };
+};
+declare const accessibilityPluginDomManager: {
+    getCurrentScript: () => HTMLScriptElement | null;
+    getScriptLocation: () => HTMLElement;
+    createScript: (config: AccessibilityWidgetConfig) => HTMLScriptElement;
+};
+type AccessibilityPluginDomManager = typeof accessibilityPluginDomManager;
+type InitialiseAccessibilityWidgetParams = {
+    logger?: Logger;
+    config: AccessibilityWidgetConfig;
+    dom: AccessibilityPluginDomManager;
+};
+declare const initialiseAccessibilityWidget: ({ logger, config, dom }: InitialiseAccessibilityWidgetParams) => void;
+
+export { AccessibilityWidgetConfig, initialiseAccessibilityWidget };

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+import { Logger } from '@inploi/sdk';
+
+type AccessibeSize = 'small' | 'medium' | 'big';
+type HorizontalPosition = 'left' | 'right';
+type VerticalPosition = 'top' | 'center' | 'bottom';
+type AccessibilityPluginLanguage = 'en' | 'es' | 'fr' | 'de' | 'pl' | 'it' | 'pt' | 'nl' | 'hu' | 'sl' | 'sk' | 'cs' | 'tr' | 'ja' | 'tw' | 'zh' | 'he' | 'ru' | 'ar';
+type AccessibeParams = {
+    statementLink: string;
+    footerHtml: string;
+    hideMobile: boolean;
+    hideTrigger: boolean;
+    disableBgProcess: boolean;
+    language: AccessibilityPluginLanguage;
+    position: HorizontalPosition;
+    leadColor: string;
+    triggerColor: string;
+    triggerRadius: string;
+    triggerPositionX: HorizontalPosition;
+    triggerPositionY: VerticalPosition;
+    triggerIcon: string;
+    triggerSize: AccessibeSize;
+    triggerOffsetX: number | undefined;
+    triggerOffsetY: number | undefined;
+    mobile: {
+        triggerSize: AccessibeSize;
+        triggerPositionX: HorizontalPosition;
+        triggerPositionY: VerticalPosition;
+        triggerOffsetX: number;
+        triggerOffsetY: number;
+        triggerRadius: string;
+    };
+};
+declare global {
+    interface Window {
+        acsbJS: {
+            init: (params: AccessibeParams) => void;
+        };
+    }
+}
+
+type Responsive<T> = {
+    mobile: T;
+    desktop: T;
+};
+type AccessibilityWidgetConfig = {
+    language?: AccessibilityPluginLanguage;
+    colors: {
+        interface: string;
+        trigger: string;
+    };
+    showTrigger?: boolean;
+    position?: {
+        x?: Responsive<HorizontalPosition>;
+        y?: Responsive<VerticalPosition>;
+        offsetX?: Responsive<number>;
+        offsetY?: Responsive<number>;
+    };
+};
+declare const accessibilityPluginDomManager: {
+    getCurrentScript: () => HTMLScriptElement | null;
+    getScriptLocation: () => HTMLElement;
+    createScript: (config: AccessibilityWidgetConfig) => HTMLScriptElement;
+};
+type AccessibilityPluginDomManager = typeof accessibilityPluginDomManager;
+type InitialiseAccessibilityWidgetParams = {
+    logger?: Logger;
+    config: AccessibilityWidgetConfig;
+    dom: AccessibilityPluginDomManager;
+};
+declare const initialiseAccessibilityWidget: ({ logger, config, dom }: InitialiseAccessibilityWidgetParams) => void;
+
+export { AccessibilityWidgetConfig, initialiseAccessibilityWidget };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";var r=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var p=Object.prototype.hasOwnProperty;var g=(i,t)=>{for(var o in t)r(i,o,{get:t[o],enumerable:!0})},d=(i,t,o,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let e of l(t))!p.call(i,e)&&e!==o&&r(i,e,{get:()=>t[e],enumerable:!(s=a(t,e))||s.enumerable});return i};var y=i=>d(r({},"__esModule",{value:!0}),i);var m={};g(m,{initialiseAccessibilityWidget:()=>n});module.exports=y(m);var u=require("@inploi/sdk");var n=({logger:i,config:t,dom:o})=>{if(!(typeof window=="undefined"||o.getCurrentScript()!==null))try{let e=o.getScriptLocation(),c=o.createScript(t);e.appendChild(c),i==null||i.info("Accessibility plugin initialised")}catch(e){i==null||i.error("Accessibility plugin failed to initialise",e)}};0&&(module.exports={initialiseAccessibilityWidget});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/accessibility.ts"],"sourcesContent":["export { initialiseAccessibilityWidget } from './accessibility';\nexport type { AccessibilityWidgetConfig } from './accessibility';\n","import { type Logger, createPlugin } from '@inploi/sdk';\n\nimport { WIDGET_SCRIPT_ID } from './accessibility.constants';\nimport { AccessibilityPluginLanguage, HorizontalPosition, VerticalPosition } from './accessibility.types';\n\ntype Responsive<T> = {\n\tmobile: T;\n\tdesktop: T;\n};\n\nexport type AccessibilityWidgetConfig = {\n\tlanguage?: AccessibilityPluginLanguage;\n\tcolors: {\n\t\tinterface: string;\n\t\ttrigger: string;\n\t};\n\tshowTrigger?: boolean;\n\tposition?: {\n\t\tx?: Responsive<HorizontalPosition>;\n\t\ty?: Responsive<VerticalPosition>;\n\t\toffsetX?: Responsive<number>;\n\t\toffsetY?: Responsive<number>;\n\t};\n};\n\nconst accessibilityPluginDomManager = {\n\tgetCurrentScript: () => {\n\t\tconst script = document.getElementById(WIDGET_SCRIPT_ID);\n\t\tif (!script) return null;\n\t\tif (!(script instanceof HTMLScriptElement))\n\t\t\tthrow new Error(`Element with id ${WIDGET_SCRIPT_ID} is not a script tag.`);\n\t\treturn script;\n\t},\n\tgetScriptLocation: () => document.querySelector('head') ?? document.body,\n\tcreateScript: (config: AccessibilityWidgetConfig) => {\n\t\tconst script = document.createElement('script');\n\t\tscript.id = WIDGET_SCRIPT_ID;\n\t\tscript.src = 'https://acsbapp.com/apps/app/dist/js/app.js';\n\t\tscript.async = true;\n\t\tscript.onload = function () {\n\t\t\twindow.acsbJS.init({\n\t\t\t\tstatementLink: '',\n\t\t\t\tfooterHtml: 'Powered by inploi',\n\t\t\t\thideMobile: false,\n\t\t\t\thideTrigger: config.showTrigger === false,\n\t\t\t\tdisableBgProcess: false,\n\t\t\t\tlanguage: config.language ?? 'en',\n\t\t\t\tposition: config.position?.x?.desktop ?? 'right',\n\t\t\t\tleadColor: config.colors.interface,\n\t\t\t\ttriggerColor: config.colors.trigger,\n\t\t\t\ttriggerRadius: '50%',\n\t\t\t\ttriggerPositionX: config.position?.x?.desktop ?? 'right',\n\t\t\t\ttriggerPositionY: config.position?.y?.desktop ?? 'bottom',\n\t\t\t\ttriggerIcon: 'people',\n\t\t\t\ttriggerSize: 'medium',\n\t\t\t\ttriggerOffsetX: config.position?.offsetX?.desktop,\n\t\t\t\ttriggerOffsetY: config.position?.offsetY?.desktop,\n\t\t\t\tmobile: {\n\t\t\t\t\ttriggerSize: 'small',\n\t\t\t\t\ttriggerPositionX: config.position?.x?.mobile ?? 'right',\n\t\t\t\t\ttriggerPositionY: config.position?.y?.mobile ?? 'bottom',\n\t\t\t\t\ttriggerOffsetX: config.position?.offsetX?.mobile ?? 4,\n\t\t\t\t\ttriggerOffsetY: config.position?.offsetY?.mobile ?? 4,\n\t\t\t\t\ttriggerRadius: '20',\n\t\t\t\t},\n\t\t\t});\n\t\t};\n\t\treturn script;\n\t},\n};\nexport type AccessibilityPluginDomManager = typeof accessibilityPluginDomManager;\n\ntype InitialiseAccessibilityWidgetParams = {\n\tlogger?: Logger;\n\tconfig: AccessibilityWidgetConfig;\n\tdom: AccessibilityPluginDomManager;\n};\nexport const initialiseAccessibilityWidget = ({ logger, config, dom }: InitialiseAccessibilityWidgetParams) => {\n\tif (typeof window === 'undefined') return;\n\tconst a11yWidget = dom.getCurrentScript();\n\tif (a11yWidget !== null) return;\n\n\ttry {\n\t\tconst scriptLocation = dom.getScriptLocation();\n\t\tconst script = dom.createScript(config);\n\t\tscriptLocation.appendChild(script);\n\t\tlogger?.info('Accessibility plugin initialised');\n\t} catch (error) {\n\t\tlogger?.error('Accessibility plugin failed to initialise', error);\n\t}\n};\n\nexport const createAccessibilityPlugin = (params: AccessibilityWidgetConfig) =>\n\tcreatePlugin('accessibility', {\n\t\tpure_createActions: ({ logger }) => {\n\t\t\treturn {\n\t\t\t\t/**\n\t\t\t\t *  Initialises the accessibility widget if not already initialised.\n\t\t\t\t *  This function is idempotent, so it can be called multiple times without side effects.\n\t\t\t\t */\n\t\t\t\tinitialise: () => initialiseAccessibilityWidget({ logger, config: params, dom: accessibilityPluginDomManager }),\n\t\t\t};\n\t\t},\n\t});\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,mCAAAE,IAAA,eAAAC,EAAAH,GCAA,IAAAI,EAA0C,uBA6EnC,IAAMC,EAAgC,CAAC,CAAE,OAAAC,EAAQ,OAAAC,EAAQ,IAAAC,CAAI,IAA2C,CAG9G,GAFI,SAAO,QAAW,aACHA,EAAI,iBAAiB,IACrB,MAEnB,GAAI,CACH,IAAMC,EAAiBD,EAAI,kBAAkB,EACvCE,EAASF,EAAI,aAAaD,CAAM,EACtCE,EAAe,YAAYC,CAAM,EACjCJ,GAAA,MAAAA,EAAQ,KAAK,mCACd,OAASK,EAAO,CACfL,GAAA,MAAAA,EAAQ,MAAM,4CAA6CK,EAC5D,CACD","names":["src_exports","__export","initialiseAccessibilityWidget","__toCommonJS","import_sdk","initialiseAccessibilityWidget","logger","config","dom","scriptLocation","script","error"]}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import{createPlugin as p}from"@inploi/sdk";var r=({logger:i,config:o,dom:t})=>{if(!(typeof window=="undefined"||t.getCurrentScript()!==null))try{let e=t.getScriptLocation(),s=t.createScript(o);e.appendChild(s),i==null||i.info("Accessibility plugin initialised")}catch(e){i==null||i.error("Accessibility plugin failed to initialise",e)}};export{r as initialiseAccessibilityWidget};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/accessibility.ts"],"sourcesContent":["import { type Logger, createPlugin } from '@inploi/sdk';\n\nimport { WIDGET_SCRIPT_ID } from './accessibility.constants';\nimport { AccessibilityPluginLanguage, HorizontalPosition, VerticalPosition } from './accessibility.types';\n\ntype Responsive<T> = {\n\tmobile: T;\n\tdesktop: T;\n};\n\nexport type AccessibilityWidgetConfig = {\n\tlanguage?: AccessibilityPluginLanguage;\n\tcolors: {\n\t\tinterface: string;\n\t\ttrigger: string;\n\t};\n\tshowTrigger?: boolean;\n\tposition?: {\n\t\tx?: Responsive<HorizontalPosition>;\n\t\ty?: Responsive<VerticalPosition>;\n\t\toffsetX?: Responsive<number>;\n\t\toffsetY?: Responsive<number>;\n\t};\n};\n\nconst accessibilityPluginDomManager = {\n\tgetCurrentScript: () => {\n\t\tconst script = document.getElementById(WIDGET_SCRIPT_ID);\n\t\tif (!script) return null;\n\t\tif (!(script instanceof HTMLScriptElement))\n\t\t\tthrow new Error(`Element with id ${WIDGET_SCRIPT_ID} is not a script tag.`);\n\t\treturn script;\n\t},\n\tgetScriptLocation: () => document.querySelector('head') ?? document.body,\n\tcreateScript: (config: AccessibilityWidgetConfig) => {\n\t\tconst script = document.createElement('script');\n\t\tscript.id = WIDGET_SCRIPT_ID;\n\t\tscript.src = 'https://acsbapp.com/apps/app/dist/js/app.js';\n\t\tscript.async = true;\n\t\tscript.onload = function () {\n\t\t\twindow.acsbJS.init({\n\t\t\t\tstatementLink: '',\n\t\t\t\tfooterHtml: 'Powered by inploi',\n\t\t\t\thideMobile: false,\n\t\t\t\thideTrigger: config.showTrigger === false,\n\t\t\t\tdisableBgProcess: false,\n\t\t\t\tlanguage: config.language ?? 'en',\n\t\t\t\tposition: config.position?.x?.desktop ?? 'right',\n\t\t\t\tleadColor: config.colors.interface,\n\t\t\t\ttriggerColor: config.colors.trigger,\n\t\t\t\ttriggerRadius: '50%',\n\t\t\t\ttriggerPositionX: config.position?.x?.desktop ?? 'right',\n\t\t\t\ttriggerPositionY: config.position?.y?.desktop ?? 'bottom',\n\t\t\t\ttriggerIcon: 'people',\n\t\t\t\ttriggerSize: 'medium',\n\t\t\t\ttriggerOffsetX: config.position?.offsetX?.desktop,\n\t\t\t\ttriggerOffsetY: config.position?.offsetY?.desktop,\n\t\t\t\tmobile: {\n\t\t\t\t\ttriggerSize: 'small',\n\t\t\t\t\ttriggerPositionX: config.position?.x?.mobile ?? 'right',\n\t\t\t\t\ttriggerPositionY: config.position?.y?.mobile ?? 'bottom',\n\t\t\t\t\ttriggerOffsetX: config.position?.offsetX?.mobile ?? 4,\n\t\t\t\t\ttriggerOffsetY: config.position?.offsetY?.mobile ?? 4,\n\t\t\t\t\ttriggerRadius: '20',\n\t\t\t\t},\n\t\t\t});\n\t\t};\n\t\treturn script;\n\t},\n};\nexport type AccessibilityPluginDomManager = typeof accessibilityPluginDomManager;\n\ntype InitialiseAccessibilityWidgetParams = {\n\tlogger?: Logger;\n\tconfig: AccessibilityWidgetConfig;\n\tdom: AccessibilityPluginDomManager;\n};\nexport const initialiseAccessibilityWidget = ({ logger, config, dom }: InitialiseAccessibilityWidgetParams) => {\n\tif (typeof window === 'undefined') return;\n\tconst a11yWidget = dom.getCurrentScript();\n\tif (a11yWidget !== null) return;\n\n\ttry {\n\t\tconst scriptLocation = dom.getScriptLocation();\n\t\tconst script = dom.createScript(config);\n\t\tscriptLocation.appendChild(script);\n\t\tlogger?.info('Accessibility plugin initialised');\n\t} catch (error) {\n\t\tlogger?.error('Accessibility plugin failed to initialise', error);\n\t}\n};\n\nexport const createAccessibilityPlugin = (params: AccessibilityWidgetConfig) =>\n\tcreatePlugin('accessibility', {\n\t\tpure_createActions: ({ logger }) => {\n\t\t\treturn {\n\t\t\t\t/**\n\t\t\t\t *  Initialises the accessibility widget if not already initialised.\n\t\t\t\t *  This function is idempotent, so it can be called multiple times without side effects.\n\t\t\t\t */\n\t\t\t\tinitialise: () => initialiseAccessibilityWidget({ logger, config: params, dom: accessibilityPluginDomManager }),\n\t\t\t};\n\t\t},\n\t});\n"],"mappings":"AAAA,OAAsB,gBAAAA,MAAoB,cA6EnC,IAAMC,EAAgC,CAAC,CAAE,OAAAC,EAAQ,OAAAC,EAAQ,IAAAC,CAAI,IAA2C,CAG9G,GAFI,SAAO,QAAW,aACHA,EAAI,iBAAiB,IACrB,MAEnB,GAAI,CACH,IAAMC,EAAiBD,EAAI,kBAAkB,EACvCE,EAASF,EAAI,aAAaD,CAAM,EACtCE,EAAe,YAAYC,CAAM,EACjCJ,GAAA,MAAAA,EAAQ,KAAK,mCACd,OAASK,EAAO,CACfL,GAAA,MAAAA,EAAQ,MAAM,4CAA6CK,EAC5D,CACD","names":["createPlugin","initialiseAccessibilityWidget","logger","config","dom","scriptLocation","script","error"]}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@inploi/plugin-accessibility",
+  "version": "1.0.0",
+  "main": "dist/accessibility.js",
+  "types": "dist/accessibility.d.ts",
+  "license": "MIT",
+  "files": [
+    "/dist",
+    "/cdn"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/accessibility.js",
+      "import": "./dist/accessibility.mjs",
+      "types": "./dist/accessibility.d.ts"
+    }
+  },
+  "dependencies": {
+    "@inploi/core": "1.4.0"
+  },
+  "peerDependencies": {
+    "@inploi/sdk": "*"
+  },
+  "devDependencies": {
+    "@happy-dom/global-registrator": "^12.6.0",
+    "@total-typescript/ts-reset": "^0.5.1",
+    "eslint": "^7.32.0",
+    "happy-dom": "^12.6.0",
+    "ts-toolbelt": "^9.6.0",
+    "tsup": "^7.2.0",
+    "typescript": "^5.1.6",
+    "tsconfig": "0.1.0",
+    "@inploi/sdk": "1.0.0",
+    "eslint-config-custom": "0.1.0"
+  },
+  "scripts": {
+    "build:npm": "tsup --dts --dts-resolve",
+    "build:cdn": "tsup --config tsup.cdn.config.ts",
+    "build": "concurrently 'pnpm run build:npm' 'pnpm run build:cdn'",
+    "dev": "tsup --watch --config tsup.cdn.config.ts",
+    "lint": "eslint \"**/*.ts*\"",
+    "test": "bun test"
+  }
+}