usercase 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,124 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# Usercase
+
+Usercase is a web plugin for embedding user research widgets into your website.
+
+## Installation
+
+### npm
+
+```bash
+npm install usercase
+```
+
+### yarn
+
+```bash
+yarn add usercase
+```
+
+## Usage
+
+### ES Module
+
+```js
+import Usercase from 'usercase';
+
+Usercase.init({
+  project: 'YOUR_PROJECT_ID'
+});
+```
+
+### CommonJS
+
+```js
+const Usercase = require('usercase');
+
+Usercase.init({
+  project: 'YOUR_PROJECT_ID'
+});
+```
+
+### Script Tag
+
+You can also use Usercase without npm by adding a script tag directly:
+
+```html
+<script>
+(function () {
+  var w = window;
+  if (!w.Usercase) { w.Usercase = {}; }
+  w.Usercase.project = "YOUR_PROJECT_ID";
+  function l() {
+    if (w.UsercaseInitialized) { return; }
+    w.UsercaseInitialized = true;
+    var s = document.createElement("script");
+    s.type = "text/javascript";
+    s.async = true;
+    s.src = "https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";
+    var x = document.getElementsByTagName("head")[0];
+    if (x) { x.appendChild(s); }
+  }
+  if (document.readyState === "complete") { l(); }
+  else { w.addEventListener("DOMContentLoaded", l); w.addEventListener("load", l); }
+})();
+</script>
+```
+
+## Framework Examples
+
+### React
+
+```jsx
+import { useEffect } from 'react';
+import Usercase from 'usercase';
+
+function App() {
+  useEffect(() => {
+    Usercase.init({ project: 'YOUR_PROJECT_ID' });
+  }, []);
+
+  return <div>My App</div>;
+}
+```
+
+### Next.js
+
+```jsx
+'use client';
+
+import { useEffect } from 'react';
+import Usercase from 'usercase';
+
+export default function UsercaseProvider({ children }) {
+  useEffect(() => {
+    Usercase.init({ project: 'YOUR_PROJECT_ID' });
+  }, []);
+
+  return <>{children}</>;
+}
+```
+
+### Vue
+
+```vue
+<script setup>
+import { onMounted } from 'vue';
+import Usercase from 'usercase';
+
+onMounted(() => {
+  Usercase.init({ project: 'YOUR_PROJECT_ID' });
+});
+</script>
+```
+
+## API
+
+### `Usercase.init(options)`
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `project` | `string` | Yes | Your Usercase project ID |
+
+## License
+
+MIT

package/dist/npm/index.cjs

@@ -0,0 +1 @@
+"use strict";const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const n=document.getElementsByTagName("head")[0];n&&n.appendChild(t)}};module.exports=e;

package/dist/npm/index.d.ts

@@ -0,0 +1,10 @@
+interface EarningbirdsOptions {
+  project: string;
+}
+
+interface Earningbirds {
+  init(options: EarningbirdsOptions): void;
+}
+
+declare const Earningbirds: Earningbirds;
+export default Earningbirds;

package/dist/npm/index.mjs

@@ -0,0 +1 @@
+const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const n=document.getElementsByTagName("head")[0];n&&n.appendChild(t)}};export{e as default};

package/package.json

@@ -1,6 +1,59 @@
-{
-  "name": "usercase",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "usercase",
+  "version": "1.0.1",
+  "description": "Usercase web plugin for user research",
+  "main": "dist/npm/index.cjs",
+  "module": "dist/npm/index.mjs",
+  "types": "dist/npm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/npm/index.mjs",
+      "require": "./dist/npm/index.cjs",
+      "types": "./dist/npm/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/npm",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "start": "node server.js",
+    "build": "node create-index.js && cross-env NODE_ENV=production rollup -c",
+    "build:dev": "node create-index.js && cross-env NODE_ENV=development rollup -c",
+    "build:npm": "cross-env BUILD=npm rollup -c",
+    "build:extension": "npm run build && node scripts/build-extension.js",
+    "build:extension-dev": "npm run build:dev && node scripts/build-extension.js",
+    "zip:extension": "cd extension && powershell -Command \"Compress-Archive -Path * -DestinationPath ../earningbirds-extension.zip -Force\"",
+    "prepublishOnly": "npm run build:npm",
+    "dev-earningbirds": "cd ../earningbirds && npm run dev",
+    "dev-web": "cd ../bluetags && npm run dev",
+    "dev-server": "cd ../earningbirds-server && npm run dev",
+    "dev-only": "cross-env NODE_ENV=development rollup -c -w",
+    "dev": "start npm run dev-web && start npm run dev-server && start node server.js && cross-env NODE_ENV=development rollup -c -w"
+  },
+  "devDependencies": {
+    "@google/genai": "^1.50.1",
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-replace": "^6.0.2",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.17.28",
+    "@types/pako": "^2.0.4",
+    "cross-env": "^7.0.3",
+    "express": "^4.18.2",
+    "playwright": "^1.58.2",
+    "rollup": "^4.38.0",
+    "rollup-plugin-import-css": "^4.2.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "html2canvas-pro": "^2.0.2",
+    "pako": "^2.1.0",
+    "rrweb": "^2.0.0-alpha.20"
+  }
+}