@tellyouai/plugin 0.1.0

package/README.md

@@ -0,0 +1,125 @@
+# Tellyou AI Plugin
+
+The plugin is available as a self-contained browser SDK and as the existing
+Cloudflare-hosted script. The npm package bundles its runtime dependencies, so
+it can be used from React, Vue, Svelte, or a plain browser application.
+
+## npm
+
+Pin an exact release when application behavior must remain stable:
+
+```sh
+npm install --save-exact @tellyouai/plugin@0.1.0
+```
+
+Initialize the plugin after the page has loaded:
+
+```ts
+import { initialize } from "@tellyouai/plugin";
+
+const plugin = await initialize({
+  entityId: "YOUR_ENTITY_ID",
+});
+
+plugin.toggle({ open: true });
+```
+
+For an inline or otherwise custom target, create the element before
+initializing:
+
+```html
+<div id="support"></div>
+```
+
+```ts
+import { initialize, type InstanceConfig } from "@tellyouai/plugin";
+
+const config: InstanceConfig = {
+  entityId: "YOUR_ENTITY_ID",
+  target: "support",
+  displayMode: "inline",
+};
+
+const plugin = await initialize(config);
+plugin.update({ options: { theme: "dark" } });
+```
+
+Pass an array to initialize multiple instances. The returned controller also
+provides `load`, `goTo`, `setConsent`, and `update` methods. Importing the
+package is safe in server-side builds, but `initialize` must run in a browser.
+
+## CDN script
+
+Existing script integrations remain supported:
+
+```html
+<script
+  type="module"
+  src="https://app.tellyou.ai/tellyouai-plugin.js?entityId=YOUR_ENTITY_ID"
+></script>
+```
+
+Query-string configuration belongs to the CDN entry. npm consumers pass all
+configuration to `initialize` directly.
+
+## Consent and storage
+
+The plugin automatically reads IAB TCF v2, Cookiebot, OneTrust, and Didomi
+consent when those APIs are available on the host page. Automatic mode grants
+functional storage and analytics by default, including when no CMP is present,
+and responds when a CMP later reports that consent was revoked.
+
+The host can provide or override consent explicitly:
+
+```js
+window.tellyouai.setConsent({ functional: true, analytics: false });
+```
+
+The equivalent event is `tellyouai-consent-change`, with the same values in
+`event.detail`. This is also the integration point for Google Consent Mode,
+whose current state cannot be reliably read from `gtag`.
+
+Optional per-instance policy:
+
+````js
+window.tellyouai = {
+  entityId: "...",
+  consent: {
+    mode: "auto", // "auto" (default), "required", or "disabled"
+    ## Development and release
+
+    Build the Cloudflare script and npm package separately:
+
+    ```sh
+    npm run build
+    npm run build:package
+    npm run test:package
+    npm run pack:check
+    ```
+
+    Before a release, update `version` with npm's version command and test the
+    generated tarball in a consuming application. Publishing the scoped package
+    requires access to the `tellyouai` npm organization:
+
+    ```sh
+    npm publish --access public
+    ```
+
+    Do not commit npm access tokens. Package and CDN releases should use the same
+    source revision and semantic version.
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: "18.3" } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs["jsx-runtime"].rules,
+  },
+});
+````

package/dist/package/index.d.ts

@@ -0,0 +1,3 @@
+import { PluginConfiguration, PluginController } from './public.ts';
+export type * from './public.ts';
+export declare const initialize: (configuration: PluginConfiguration) => Promise<PluginController>;