@guidelytech/sveltekit 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# @guidelytech/sveltekit
 
-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.
+SvelteKit helpers: creates the client in the browser only and calls `page()` after every
+navigation. Re-exports everything from `@guidelytech/svelte`.
+
+```bash
+pnpm add @guidelytech/sveltekit
+```
+
+```svelte
+<!-- src/routes/+layout.svelte -->
+<script lang="ts">
+  import { env } from "$env/dynamic/public";
+  import { initGuidely, guidelyEnv, syncGuidelyUser } from "@guidelytech/sveltekit";
+
+  let { data, children } = $props();
+  initGuidely({ ...guidelyEnv(env), debug: import.meta.env.DEV });
+
+  // data.user from +layout.server.ts — identifies on sign-in/change, resets on sign-out.
+  $effect(() => syncGuidelyUser(data.user ? { id: data.user.id, traits: { role: data.user.role } } : null));
+</script>
+
+{@render children()}
+```
+
+Page views are tracked automatically on every navigation; users are anonymous until identified.
+
+| Export | Description |
+|---|---|
+| `initGuidely(options)` | Call once during root layout initialisation. Returns the client in the browser, `null` on the server. Uses `afterNavigate` from `$app/navigation` to call `page()` and destroys the client when the layout is destroyed. |
+| `guidelyEnv(env)` | Reads `PUBLIC_GUIDELY_PROJECT_ID`/`_ENV`/`_API_URL` (`$env/static/public`, `$env/dynamic/public`) or the `VITE_GUIDELY_*` equivalents (`import.meta.env`). |
+| `syncGuidelyUser(user \| null \| undefined)` | Keeps the Guidely user in step with your session (re-exported from `@guidelytech/svelte`). |
+| everything from `@guidelytech/svelte` | stores, actions and context helpers. |

package/dist/index.cjs

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  guidelyEnv: () => guidelyEnv,
+  initGuidely: () => initGuidely
+});
+module.exports = __toCommonJS(index_exports);
+var import_environment = require("$app/environment");
+var import_navigation = require("$app/navigation");
+var import_svelte = require("@guidelytech/svelte");
+var import_svelte2 = require("svelte");
+__reExport(index_exports, require("@guidelytech/svelte"), module.exports);
+function initGuidely(options) {
+  if (!import_environment.browser) {
+    (0, import_svelte.setGuidelyContext)(null);
+    return null;
+  }
+  const client = (0, import_svelte.createGuidely)(options);
+  (0, import_svelte.setGuidelyContext)(client);
+  (0, import_navigation.afterNavigate)((nav) => {
+    if (nav.type !== "enter") client.page(window.location.href);
+  });
+  (0, import_svelte2.onDestroy)(() => {
+    if (guidelyStoreIs(client)) (0, import_svelte.destroyGuidely)();
+  });
+  return client;
+}
+function guidelyStoreIs(client) {
+  let current = null;
+  import_svelte.guidely.subscribe((c) => current = c)();
+  return current === client;
+}
+function guidelyEnv(env) {
+  return {
+    projectId: env.VITE_GUIDELY_PROJECT_ID || env.PUBLIC_GUIDELY_PROJECT_ID || "",
+    environment: env.VITE_GUIDELY_ENV || env.PUBLIC_GUIDELY_ENV || void 0,
+    apiUrl: env.VITE_GUIDELY_API_URL || env.PUBLIC_GUIDELY_API_URL || void 0
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  guidelyEnv,
+  initGuidely,
+  ...require("@guidelytech/svelte")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { browser } from \"$app/environment\";\nimport { afterNavigate } from \"$app/navigation\";\nimport { createGuidely, destroyGuidely, guidely, setGuidelyContext, type GuidelyClient, type GuidelyOptions } from \"@guidelytech/svelte\";\nimport { onDestroy } from \"svelte\";\n\nexport * from \"@guidelytech/svelte\";\n\n/**\n * Call once from the root `+layout.svelte` (during component initialisation). Creates the client\n * in the browser only, calls `page()` after every SvelteKit navigation and destroys the client\n * when the layout unmounts (HMR). Returns `null` on the server. Keep the signed-in user in step\n * with `syncGuidelyUser` (re-exported from `@guidelytech/svelte`).\n */\nexport function initGuidely(options: GuidelyOptions): GuidelyClient | null {\n  if (!browser) {\n    setGuidelyContext(null);\n    return null;\n  }\n  const client = createGuidely(options);\n  setGuidelyContext(client);\n  afterNavigate((nav) => {\n    if (nav.type !== \"enter\") client.page(window.location.href);\n  });\n  onDestroy(() => {\n    if (guidelyStoreIs(client)) destroyGuidely();\n  });\n  return client;\n}\n\nfunction guidelyStoreIs(client: GuidelyClient): boolean {\n  let current: GuidelyClient | null = null;\n  guidely.subscribe((c) => (current = c))();\n  return current === client;\n}\n\n/**\n * Reads the public Guidely variables into client options: `VITE_GUIDELY_*` (from `import.meta.env`)\n * or SvelteKit's `PUBLIC_GUIDELY_*` (from `$env/static/public` or `$env/dynamic/public`).\n */\nexport function guidelyEnv(env: Record<string, string | undefined>): Pick<GuidelyOptions, \"projectId\" | \"environment\" | \"apiUrl\"> {\n  return {\n    projectId: env.VITE_GUIDELY_PROJECT_ID || env.PUBLIC_GUIDELY_PROJECT_ID || \"\",\n    environment: ((env.VITE_GUIDELY_ENV || env.PUBLIC_GUIDELY_ENV) as GuidelyOptions[\"environment\"]) || undefined,\n    apiUrl: env.VITE_GUIDELY_API_URL || env.PUBLIC_GUIDELY_API_URL || undefined,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAwB;AACxB,wBAA8B;AAC9B,oBAAmH;AACnH,IAAAA,iBAA0B;AAE1B,0BAAc,gCALd;AAaO,SAAS,YAAY,SAA+C;AACzE,MAAI,CAAC,4BAAS;AACZ,yCAAkB,IAAI;AACtB,WAAO;AAAA,EACT;AACA,QAAM,aAAS,6BAAc,OAAO;AACpC,uCAAkB,MAAM;AACxB,uCAAc,CAAC,QAAQ;AACrB,QAAI,IAAI,SAAS,QAAS,QAAO,KAAK,OAAO,SAAS,IAAI;AAAA,EAC5D,CAAC;AACD,gCAAU,MAAM;AACd,QAAI,eAAe,MAAM,EAAG,mCAAe;AAAA,EAC7C,CAAC;AACD,SAAO;AACT;AAEA,SAAS,eAAe,QAAgC;AACtD,MAAI,UAAgC;AACpC,wBAAQ,UAAU,CAAC,MAAO,UAAU,CAAE,EAAE;AACxC,SAAO,YAAY;AACrB;AAMO,SAAS,WAAW,KAAuG;AAChI,SAAO;AAAA,IACL,WAAW,IAAI,2BAA2B,IAAI,6BAA6B;AAAA,IAC3E,aAAe,IAAI,oBAAoB,IAAI,sBAAyD;AAAA,IACpG,QAAQ,IAAI,wBAAwB,IAAI,0BAA0B;AAAA,EACpE;AACF;","names":["import_svelte"]}

package/dist/index.d.cts

@@ -0,0 +1,17 @@
+import { GuidelyOptions, GuidelyClient } from '@guidelytech/svelte';
+export * from '@guidelytech/svelte';
+
+/**
+ * Call once from the root `+layout.svelte` (during component initialisation). Creates the client
+ * in the browser only, calls `page()` after every SvelteKit navigation and destroys the client
+ * when the layout unmounts (HMR). Returns `null` on the server. Keep the signed-in user in step
+ * with `syncGuidelyUser` (re-exported from `@guidelytech/svelte`).
+ */
+declare function initGuidely(options: GuidelyOptions): GuidelyClient | null;
+/**
+ * Reads the public Guidely variables into client options: `VITE_GUIDELY_*` (from `import.meta.env`)
+ * or SvelteKit's `PUBLIC_GUIDELY_*` (from `$env/static/public` or `$env/dynamic/public`).
+ */
+declare function guidelyEnv(env: Record<string, string | undefined>): Pick<GuidelyOptions, "projectId" | "environment" | "apiUrl">;
+
+export { guidelyEnv, initGuidely };

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { GuidelyOptions, GuidelyClient } from '@guidelytech/svelte';
+export * from '@guidelytech/svelte';
+
+/**
+ * Call once from the root `+layout.svelte` (during component initialisation). Creates the client
+ * in the browser only, calls `page()` after every SvelteKit navigation and destroys the client
+ * when the layout unmounts (HMR). Returns `null` on the server. Keep the signed-in user in step
+ * with `syncGuidelyUser` (re-exported from `@guidelytech/svelte`).
+ */
+declare function initGuidely(options: GuidelyOptions): GuidelyClient | null;
+/**
+ * Reads the public Guidely variables into client options: `VITE_GUIDELY_*` (from `import.meta.env`)
+ * or SvelteKit's `PUBLIC_GUIDELY_*` (from `$env/static/public` or `$env/dynamic/public`).
+ */
+declare function guidelyEnv(env: Record<string, string | undefined>): Pick<GuidelyOptions, "projectId" | "environment" | "apiUrl">;
+
+export { guidelyEnv, initGuidely };

package/dist/index.js

@@ -0,0 +1,38 @@
+// src/index.ts
+import { browser } from "$app/environment";
+import { afterNavigate } from "$app/navigation";
+import { createGuidely, destroyGuidely, guidely, setGuidelyContext } from "@guidelytech/svelte";
+import { onDestroy } from "svelte";
+export * from "@guidelytech/svelte";
+function initGuidely(options) {
+  if (!browser) {
+    setGuidelyContext(null);
+    return null;
+  }
+  const client = createGuidely(options);
+  setGuidelyContext(client);
+  afterNavigate((nav) => {
+    if (nav.type !== "enter") client.page(window.location.href);
+  });
+  onDestroy(() => {
+    if (guidelyStoreIs(client)) destroyGuidely();
+  });
+  return client;
+}
+function guidelyStoreIs(client) {
+  let current = null;
+  guidely.subscribe((c) => current = c)();
+  return current === client;
+}
+function guidelyEnv(env) {
+  return {
+    projectId: env.VITE_GUIDELY_PROJECT_ID || env.PUBLIC_GUIDELY_PROJECT_ID || "",
+    environment: env.VITE_GUIDELY_ENV || env.PUBLIC_GUIDELY_ENV || void 0,
+    apiUrl: env.VITE_GUIDELY_API_URL || env.PUBLIC_GUIDELY_API_URL || void 0
+  };
+}
+export {
+  guidelyEnv,
+  initGuidely
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { browser } from \"$app/environment\";\nimport { afterNavigate } from \"$app/navigation\";\nimport { createGuidely, destroyGuidely, guidely, setGuidelyContext, type GuidelyClient, type GuidelyOptions } from \"@guidelytech/svelte\";\nimport { onDestroy } from \"svelte\";\n\nexport * from \"@guidelytech/svelte\";\n\n/**\n * Call once from the root `+layout.svelte` (during component initialisation). Creates the client\n * in the browser only, calls `page()` after every SvelteKit navigation and destroys the client\n * when the layout unmounts (HMR). Returns `null` on the server. Keep the signed-in user in step\n * with `syncGuidelyUser` (re-exported from `@guidelytech/svelte`).\n */\nexport function initGuidely(options: GuidelyOptions): GuidelyClient | null {\n  if (!browser) {\n    setGuidelyContext(null);\n    return null;\n  }\n  const client = createGuidely(options);\n  setGuidelyContext(client);\n  afterNavigate((nav) => {\n    if (nav.type !== \"enter\") client.page(window.location.href);\n  });\n  onDestroy(() => {\n    if (guidelyStoreIs(client)) destroyGuidely();\n  });\n  return client;\n}\n\nfunction guidelyStoreIs(client: GuidelyClient): boolean {\n  let current: GuidelyClient | null = null;\n  guidely.subscribe((c) => (current = c))();\n  return current === client;\n}\n\n/**\n * Reads the public Guidely variables into client options: `VITE_GUIDELY_*` (from `import.meta.env`)\n * or SvelteKit's `PUBLIC_GUIDELY_*` (from `$env/static/public` or `$env/dynamic/public`).\n */\nexport function guidelyEnv(env: Record<string, string | undefined>): Pick<GuidelyOptions, \"projectId\" | \"environment\" | \"apiUrl\"> {\n  return {\n    projectId: env.VITE_GUIDELY_PROJECT_ID || env.PUBLIC_GUIDELY_PROJECT_ID || \"\",\n    environment: ((env.VITE_GUIDELY_ENV || env.PUBLIC_GUIDELY_ENV) as GuidelyOptions[\"environment\"]) || undefined,\n    apiUrl: env.VITE_GUIDELY_API_URL || env.PUBLIC_GUIDELY_API_URL || undefined,\n  };\n}\n"],"mappings":";AAAA,SAAS,eAAe;AACxB,SAAS,qBAAqB;AAC9B,SAAS,eAAe,gBAAgB,SAAS,yBAAkE;AACnH,SAAS,iBAAiB;AAE1B,cAAc;AAQP,SAAS,YAAY,SAA+C;AACzE,MAAI,CAAC,SAAS;AACZ,sBAAkB,IAAI;AACtB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,cAAc,OAAO;AACpC,oBAAkB,MAAM;AACxB,gBAAc,CAAC,QAAQ;AACrB,QAAI,IAAI,SAAS,QAAS,QAAO,KAAK,OAAO,SAAS,IAAI;AAAA,EAC5D,CAAC;AACD,YAAU,MAAM;AACd,QAAI,eAAe,MAAM,EAAG,gBAAe;AAAA,EAC7C,CAAC;AACD,SAAO;AACT;AAEA,SAAS,eAAe,QAAgC;AACtD,MAAI,UAAgC;AACpC,UAAQ,UAAU,CAAC,MAAO,UAAU,CAAE,EAAE;AACxC,SAAO,YAAY;AACrB;AAMO,SAAS,WAAW,KAAuG;AAChI,SAAO;AAAA,IACL,WAAW,IAAI,2BAA2B,IAAI,6BAA6B;AAAA,IAC3E,aAAe,IAAI,oBAAoB,IAAI,sBAAyD;AAAA,IACpG,QAAQ,IAAI,wBAAwB,IAAI,0BAA0B;AAAA,EACpE;AACF;","names":[]}

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "@guidelytech/sveltekit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "SvelteKit helpers for Guidely",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@guidelytech/svelte": "0.2.0",
+    "@guidelytech/sdk-core": "0.2.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.7",
+    "happy-dom": "^17.6.3",
+    "eslint": "^9.39.5",
+    "@eslint/js": "^9.39.5",
+    "typescript-eslint": "^8.46.0",
+    "svelte": "^5.57.2",
+    "@sveltejs/kit": "^2.70.3"
+  },
+  "peerDependencies": {
+    "svelte": ">=4.0.0",
+    "@sveltejs/kit": ">=2.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/parmarg/Guidely.git",
+    "directory": "packages/sveltekit"
+  },
+  "homepage": "https://github.com/parmarg/Guidely/tree/main/packages/sveltekit#readme",
+  "bugs": {
+    "url": "https://github.com/parmarg/Guidely/issues"
+  },
+  "keywords": [
+    "guidely",
+    "product-adoption",
+    "onboarding",
+    "product-tour",
+    "in-app-guidance",
+    "sveltekit"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "lint": "eslint src",
+    "clean": "rm -rf dist"
+  }
 }