@croct/plug 0.16.4 → 0.17.0

package/index.d.cts

@@ -0,0 +1,27 @@
+import { GlobalPlug } from './plug.cjs';
+export { Configuration, Plug } from './plug.cjs';
+import '@croct/sdk/facade/sessionFacade';
+import '@croct/sdk/facade/userFacade';
+import '@croct/sdk/facade/trackerFacade';
+import '@croct/sdk/facade/evaluatorFacade';
+import '@croct/sdk/facade/sdkFacade';
+import '@croct/sdk/utilityTypes';
+import '@croct/sdk/trackingEvents';
+import '@croct/sdk/facade/contentFetcherFacade';
+import './plugin.cjs';
+import '@croct/sdk/token';
+import './sdk/index.cjs';
+import '@croct/sdk/eventManager';
+import '@croct/sdk/sdkEvents';
+import '@croct/sdk/logging';
+import '@croct/sdk/tab';
+import '@croct/sdk/cid';
+import './slot.cjs';
+import '@croct/json';
+import './versioning.cjs';
+import './component.cjs';
+import '@croct/json/mutable';
+
+declare const _default: GlobalPlug;
+
+export { _default as default };

package/index.d.ts

@@ -1,4 +1,27 @@
-import { Configuration, Plug, GlobalPlug } from './plug';
-export { Configuration, Plug };
+import { GlobalPlug } from './plug.js';
+export { Configuration, Plug } from './plug.js';
+import '@croct/sdk/facade/sessionFacade';
+import '@croct/sdk/facade/userFacade';
+import '@croct/sdk/facade/trackerFacade';
+import '@croct/sdk/facade/evaluatorFacade';
+import '@croct/sdk/facade/sdkFacade';
+import '@croct/sdk/utilityTypes';
+import '@croct/sdk/trackingEvents';
+import '@croct/sdk/facade/contentFetcherFacade';
+import './plugin.js';
+import '@croct/sdk/token';
+import './sdk/index.js';
+import '@croct/sdk/eventManager';
+import '@croct/sdk/sdkEvents';
+import '@croct/sdk/logging';
+import '@croct/sdk/tab';
+import '@croct/sdk/cid';
+import './slot.js';
+import '@croct/json';
+import './versioning.js';
+import './component.js';
+import '@croct/json/mutable';
+
 declare const _default: GlobalPlug;
-export default _default;
+
+export { _default as default };

package/index.js

@@ -1,6 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const plug_1 = require("./plug");
-/* eslint-disable-next-line import/no-default-export -- Should be default export */
-exports.default = new plug_1.GlobalPlug();
-//# sourceMappingURL=index.js.map
+import { GlobalPlug } from "./plug.js";
+var index_default = new GlobalPlug();
+export {
+  index_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/plug",
-  "version": "0.16.4",
+  "version": "0.17.0",
   "description": "A fully-featured devkit for building natively personalized applications.",
   "license": "MIT",
   "author": {
@@ -15,8 +15,27 @@
     "javascript",
     "typescript"
   ],
+  "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
+  "exports": {
+    "./*": {
+      "import": "./*.js",
+      "require": "./*.cjs"
+    },
+    "./api": {
+      "import": "./api/index.js",
+      "require": "./api/index.cjs"
+    },
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./sdk": {
+      "import": "./sdk/index.js",
+      "require": "./sdk/index.cjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/croct-tech/plug-js.git"
@@ -27,14 +46,16 @@
   "homepage": "https://github.com/croct-tech/plug-js",
   "scripts": {
     "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
-    "test": "jest -c jest.config.js --coverage",
+    "test": "jest -c jest.config.mjs --coverage",
     "validate": "tsc --noEmit",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsup",
+    "postbuild": "./post-build.mjs",
     "bundle": "rollup -c"
   },
   "dependencies": {
+    "@croct/content": "^1.1.0",
     "@croct/json": "^2.1.0",
-    "@croct/sdk": "^0.17.6",
+    "@croct/sdk": "^0.18.0",
     "tslib": "^2.7.0"
   },
   "devDependencies": {
@@ -45,13 +66,15 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.0.0",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/parser": "^7.0.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "esbuild-fix-imports-plugin": "^1.0.19",
     "eslint": "^8.27.0",
     "jest": "^29.3.1",
     "jest-environment-jsdom": "^29.3.1",
     "rollup": "^4.0.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
+    "tsup": "^8.4.0",
     "typescript": "^5.0.0"
   },
   "browserslist": [
@@ -59,7 +82,11 @@
   ],
   "files": [
     "**/*.js",
+    "**/*.cjs",
+    "**/*.mjs",
     "**/*.ts",
+    "**/*.mts",
+    "**/*.cts",
     "**/*.map"
   ]
-}
+}

package/playground.cjs

@@ -0,0 +1,166 @@
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var playground_exports = {};
+__export(playground_exports, {
+  PlaygroundPlugin: () => PlaygroundPlugin,
+  factory: () => factory
+});
+module.exports = __toCommonJS(playground_exports);
+var import_error = require("@croct/sdk/error");
+var import_evaluatorFacade = require("@croct/sdk/facade/evaluatorFacade");
+var import_constants = require('./constants.cjs');
+const CONNECTION_PARAMETER = "__cplay";
+class PlaygroundPlugin {
+  constructor(configuration) {
+    this.sdkVersion = configuration.sdkVersion;
+    this.appId = configuration.appId;
+    this.connectionId = configuration.connectionId;
+    this.tab = configuration.tab;
+    this.contextFactory = configuration.contextFactory;
+    this.storage = configuration.storage;
+    this.eventSubscriber = configuration.eventSubscriber;
+    this.cidAssigner = configuration.cidAssigner;
+    this.tokenProvider = configuration.tokenProvider;
+    this.logger = configuration.logger;
+  }
+  enable() {
+    const connectionId = this.resolveConnectionId();
+    if (connectionId === null) {
+      return;
+    }
+    this.syncListener = () => this.cidAssigner.assignCid().then((cid) => {
+      this.syncToken(connectionId, cid);
+    }).catch((error) => {
+      this.logger.warn(`Sync failed: ${(0, import_error.formatCause)(error)}`);
+    });
+    this.eventSubscriber.addListener("tokenChanged", this.syncListener);
+    this.tab.addListener("urlChange", this.syncListener);
+    return this.syncListener();
+  }
+  resolveConnectionId() {
+    if (this.connectionId !== void 0) {
+      this.logger.debug("Connection ID passed in configuration");
+      return this.connectionId;
+    }
+    const url = new URL(this.tab.url);
+    let connectionId = url.searchParams.get(CONNECTION_PARAMETER);
+    if (connectionId === null || connectionId === "") {
+      this.logger.debug("No connection ID found in URL");
+      connectionId = this.storage.getItem("connectionId");
+      this.logger.debug(
+        connectionId !== null ? "Previous connection ID found" : "No previous connection ID found"
+      );
+      return connectionId;
+    }
+    this.logger.debug("Connection ID found in URL");
+    this.storage.setItem("connectionId", connectionId);
+    return connectionId;
+  }
+  disable() {
+    if (this.syncListener !== void 0) {
+      this.eventSubscriber.removeListener("tokenChanged", this.syncListener);
+      this.tab.removeListener("urlChange", this.syncListener);
+      delete this.syncListener;
+    }
+  }
+  syncToken(connectionId, cid) {
+    const iframe = document.createElement("iframe");
+    iframe.setAttribute("src", import_constants.PLAYGROUND_CONNECT_URL);
+    iframe.setAttribute("sandbox", "allow-scripts allow-same-origin");
+    iframe.style.visibility = "hidden";
+    iframe.style.opacity = "0";
+    iframe.style.border = "0";
+    iframe.style.width = "0";
+    iframe.style.height = "0";
+    const context = this.createContext();
+    iframe.onload = () => {
+      if (iframe.contentWindow === null) {
+        if (document.body.contains(iframe)) {
+          document.body.removeChild(iframe);
+        }
+        this.logger.warn("Sync handshake failed");
+        return;
+      }
+      const listener = (event) => {
+        if (event.origin !== import_constants.PLAYGROUND_ORIGIN || event.data !== connectionId) {
+          return;
+        }
+        window.removeEventListener("message", listener);
+        if (document.body.contains(iframe)) {
+          document.body.removeChild(iframe);
+        }
+        this.logger.debug("Sync completed");
+      };
+      window.addEventListener("message", listener);
+      const payload = {
+        appId: this.appId,
+        connectionId,
+        sdkVersion: this.sdkVersion,
+        tabId: this.tab.id,
+        cid,
+        token: this.tokenProvider.getToken()?.toString() ?? null,
+        context
+      };
+      iframe.contentWindow.postMessage(payload, import_constants.PLAYGROUND_ORIGIN);
+      this.logger.debug("Waiting for sync acknowledgment...");
+    };
+    this.logger.debug("Sync started");
+    const connect = () => {
+      document.body.appendChild(iframe);
+    };
+    if (document.body === null) {
+      document.addEventListener("DOMContentLoaded", connect);
+    } else {
+      connect();
+    }
+  }
+  createContext() {
+    const { page, campaign, timeZone } = this.contextFactory.createContext();
+    const context = {};
+    if (page !== void 0) {
+      context.page = page;
+    }
+    if (campaign !== void 0) {
+      context.campaign = campaign;
+    }
+    if (timeZone !== void 0) {
+      context.timeZone = timeZone;
+    }
+    return context;
+  }
+}
+const factory = (props) => {
+  const { sdk, options } = props;
+  return new PlaygroundPlugin({
+    sdkVersion: sdk.version,
+    appId: sdk.appId,
+    connectionId: options.connectionId,
+    tab: sdk.tab,
+    storage: sdk.getTabStorage(),
+    tokenProvider: sdk.userTokenStore,
+    cidAssigner: sdk.cidAssigner,
+    contextFactory: new import_evaluatorFacade.TabContextFactory(sdk.tab),
+    eventSubscriber: sdk.eventManager,
+    logger: sdk.getLogger()
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PlaygroundPlugin,
+  factory
+});

package/playground.d.cts

@@ -0,0 +1,64 @@
+import { CidAssigner } from '@croct/sdk/cid';
+import { ContextFactory } from '@croct/sdk/facade/evaluatorFacade';
+import { Campaign, Page } from '@croct/sdk/evaluator';
+import { Plugin, PluginFactory } from './plugin.cjs';
+import { SdkEventSubscriber } from './sdk/index.cjs';
+import { TokenProvider } from '@croct/sdk/token';
+import { Tab } from '@croct/sdk/tab';
+import { Logger } from '@croct/sdk/logging';
+import '@croct/sdk/facade/trackerFacade';
+import '@croct/sdk/facade/userFacade';
+import '@croct/sdk/facade/sessionFacade';
+import '@croct/sdk/eventManager';
+import '@croct/sdk/sdkEvents';
+
+type Configuration = {
+    appId: string;
+    connectionId?: string;
+    sdkVersion: string;
+    tab: Tab;
+    contextFactory: ContextFactory;
+    storage: Storage;
+    eventSubscriber: SdkEventSubscriber;
+    cidAssigner: CidAssigner;
+    tokenProvider: TokenProvider;
+    logger: Logger;
+};
+type SyncPayload = {
+    appId: string;
+    connectionId: string;
+    sdkVersion: string;
+    cid: string;
+    tabId: string;
+    token: string | null;
+    context: {
+        campaign?: Campaign;
+        page?: Page;
+        timezone?: string;
+    };
+};
+declare class PlaygroundPlugin implements Plugin {
+    private readonly sdkVersion;
+    private readonly appId;
+    private readonly connectionId?;
+    private readonly tab;
+    private readonly contextFactory;
+    private readonly storage;
+    private readonly eventSubscriber;
+    private readonly cidAssigner;
+    private readonly tokenProvider;
+    private readonly logger;
+    private syncListener?;
+    constructor(configuration: Configuration);
+    enable(): Promise<void> | void;
+    private resolveConnectionId;
+    disable(): Promise<void> | void;
+    private syncToken;
+    private createContext;
+}
+type Options = {
+    connectionId?: string;
+};
+declare const factory: PluginFactory<Options>;
+
+export { type Configuration, type Options, PlaygroundPlugin, type SyncPayload, factory };

package/playground.d.ts

@@ -1,10 +1,18 @@
 import { CidAssigner } from '@croct/sdk/cid';
 import { ContextFactory } from '@croct/sdk/facade/evaluatorFacade';
 import { Campaign, Page } from '@croct/sdk/evaluator';
-import { Plugin, PluginFactory } from './plugin';
-import { Logger, SdkEventSubscriber, Tab } from './sdk';
-import { TokenProvider } from './sdk/token';
-export type Configuration = {
+import { Plugin, PluginFactory } from './plugin.js';
+import { SdkEventSubscriber } from './sdk/index.js';
+import { TokenProvider } from '@croct/sdk/token';
+import { Tab } from '@croct/sdk/tab';
+import { Logger } from '@croct/sdk/logging';
+import '@croct/sdk/facade/trackerFacade';
+import '@croct/sdk/facade/userFacade';
+import '@croct/sdk/facade/sessionFacade';
+import '@croct/sdk/eventManager';
+import '@croct/sdk/sdkEvents';
+
+type Configuration = {
     appId: string;
     connectionId?: string;
     sdkVersion: string;
@@ -16,7 +24,7 @@ export type Configuration = {
     tokenProvider: TokenProvider;
     logger: Logger;
 };
-export type SyncPayload = {
+type SyncPayload = {
     appId: string;
     connectionId: string;
     sdkVersion: string;
@@ -29,7 +37,7 @@ export type SyncPayload = {
         timezone?: string;
     };
 };
-export declare class PlaygroundPlugin implements Plugin {
+declare class PlaygroundPlugin implements Plugin {
     private readonly sdkVersion;
     private readonly appId;
     private readonly connectionId?;
@@ -48,7 +56,9 @@ export declare class PlaygroundPlugin implements Plugin {
     private syncToken;
     private createContext;
 }
-export type Options = {
+type Options = {
     connectionId?: string;
 };
-export declare const factory: PluginFactory<Options>;
+declare const factory: PluginFactory<Options>;
+
+export { type Configuration, type Options, PlaygroundPlugin, type SyncPayload, factory };