featurely-site-manager 1.1.26 → 1.1.29

package/README.md

@@ -1,6 +1,6 @@
 # featurely-site-manager
 
-Powerful site management SDK for controlling maintenance mode, displaying status messages, and managing site-wide features from your Featurely dashboard.
+Powerful site management SDK for controlling maintenance mode, displaying status messages, managing site-wide features, and scanning your project's dependencies for vulnerabilities — all from your Featurely dashboard.
 
 ## 📦 Installation
 
@@ -8,7 +8,63 @@ Powerful site management SDK for controlling maintenance mode, displaying status
 npm install featurely-site-manager
 ```
 
-## 🚀 Quick Start
+## 🔍 Package Security Scanning (CLI)
+
+Scan your project's dependencies for outdated versions, known CVEs, and breaking changes. Results appear instantly in your Featurely dashboard under **Package security**.
+
+### Run a scan
+
+```bash
+npx featurely-site-manager scan packages \
+  --key YOUR_API_KEY \
+  --project YOUR_PROJECT_ID
+```
+
+Run this from the directory that contains your `package.json`. After the first scan your package list is stored — use the **Re-scan** button in the dashboard to re-check without the CLI.
+
+### What gets reported
+
+| Check                                         | Source                                       |
+| --------------------------------------------- | -------------------------------------------- |
+| Installed vs latest version                   | npm registry                                 |
+| Breaking change detection (major bump)        | semver comparison                            |
+| Known CVEs — critical / high / moderate / low | [OSV database](https://osv.dev) (GHSA + NVD) |
+| Deprecated packages                           | npm registry                                 |
+| License (SPDX)                                | npm registry                                 |
+
+### GitHub Actions — automatic scanning
+
+Add to `.github/workflows/featurely-scan.yml` and set `FEATURELY_API_KEY` + `FEATURELY_PROJECT_ID` in your repository secrets.
+
+```yaml
+name: Featurely package scan
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "package.json"
+      - "package-lock.json"
+      - "yarn.lock"
+      - "pnpm-lock.yaml"
+  workflow_dispatch:
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - name: Run Featurely package scan
+        run: |
+          npx featurely-site-manager scan packages \
+            --key ${{ secrets.FEATURELY_API_KEY }} \
+            --project ${{ secrets.FEATURELY_PROJECT_ID }}
+```
+
+## 🚀 Quick Start (SDK)
 
 ```typescript
 import { SiteManager } from "featurely-site-manager";

package/dist/cli.d.mts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.mjs

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import { readFileSync } from "fs";
+import { resolve } from "path";
+function parseArgs(argv) {
+  const args = {};
+  for (let i = 0; i < argv.length; i++) {
+    if (argv[i].startsWith("--") && i + 1 < argv.length && !argv[i + 1].startsWith("--")) {
+      args[argv[i].slice(2)] = argv[i + 1];
+      i++;
+    }
+  }
+  return args;
+}
+async function main() {
+  var _a, _b, _c;
+  const rawArgs = process.argv.slice(2);
+  const isScanPackages = rawArgs[0] === "scan" && rawArgs[1] === "packages";
+  if (!isScanPackages) {
+    console.error(
+      "Usage: featurely-site-manager scan packages --key <api-key> --project <project-id>"
+    );
+    process.exit(1);
+  }
+  const args = parseArgs(rawArgs.slice(2));
+  const apiKey = args["key"];
+  const projectId = args["project"];
+  const baseUrl = (_a = args["url"]) != null ? _a : "https://featurely.no";
+  if (!apiKey) {
+    console.error("Error: --key is required");
+    process.exit(1);
+  }
+  if (!projectId) {
+    console.error("Error: --project is required");
+    process.exit(1);
+  }
+  const pkgPath = resolve(process.cwd(), "package.json");
+  let pkgJson;
+  try {
+    pkgJson = JSON.parse(readFileSync(pkgPath, "utf8"));
+  } catch {
+    console.error(`Error: Could not read package.json at ${pkgPath}`);
+    process.exit(1);
+  }
+  const deps = (_b = pkgJson.dependencies) != null ? _b : {};
+  const devDeps = (_c = pkgJson.devDependencies) != null ? _c : {};
+  const packages = [
+    ...Object.entries(deps).map(([name, version]) => ({
+      name,
+      version: version.replace(/^[\^~>=<]/, "")
+    })),
+    ...Object.entries(devDeps).map(([name, version]) => ({
+      name,
+      version: version.replace(/^[\^~>=<]/, "")
+    }))
+  ];
+  if (packages.length === 0) {
+    console.log("No dependencies found in package.json \u2014 nothing to scan.");
+    process.exit(0);
+  }
+  console.log(`Scanning ${packages.length} packages for project ${projectId}\u2026`);
+  const url = `${baseUrl}/api/projects/${projectId}/packages`;
+  let res;
+  try {
+    res = await fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "x-api-key": apiKey
+      },
+      body: JSON.stringify({ packages })
+    });
+  } catch (err) {
+    console.error("Error: Network request failed.", err);
+    process.exit(1);
+  }
+  if (!res.ok) {
+    const body = await res.text();
+    console.error(`Error: API returned ${res.status}. ${body}`);
+    process.exit(1);
+  }
+  const data = await res.json();
+  const count = Array.isArray(data.packages) ? data.packages.length : packages.length;
+  console.log(
+    `\u2713 Scan complete. ${count} packages analysed. View results in your Featurely dashboard.`
+  );
+}
+main();

package/dist/index.d.mts

@@ -0,0 +1,255 @@
+declare const SDK_VERSION = "1.1.28";
+type MessageType = "info" | "warning" | "error" | "success";
+type MessagePosition = "top" | "bottom";
+type MessageStyle = "banner" | "toast";
+interface StatusMessage {
+    id: string;
+    type: MessageType;
+    title: string;
+    message: string;
+    icon?: string;
+    dismissible: boolean;
+    position: MessagePosition;
+    style: MessageStyle;
+    expiresAt?: string;
+    startsAt?: string;
+    targetPages?: string[];
+    cta?: {
+        text: string;
+        url: string;
+        action?: string;
+    };
+    priority?: number;
+}
+interface FeatureFlag {
+    id: string;
+    key: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    rolloutPercentage?: number;
+    targetEmails?: string[];
+    excludeEmails?: string[];
+    variants?: {
+        key: string;
+        name: string;
+        weight: number;
+    }[];
+    defaultVariant?: string;
+    targetAttributes?: Array<{
+        attribute: string;
+        operator: "equals" | "not_equals" | "contains" | "greater_than" | "less_than";
+        value: string | number | boolean;
+    }>;
+}
+interface MaintenanceConfig {
+    enabled: boolean;
+    type: "default" | "custom";
+    customHtml?: string;
+    expectedRestoration?: string;
+    showStatusLink: boolean;
+    statusPageUrl?: string;
+    whitelist: {
+        localStorageKeys?: string[];
+        emails?: string[];
+        ips?: string[];
+    };
+}
+interface AppVersion {
+    version: string;
+    title: string;
+    releaseNotes?: string;
+    downloadUrl?: string;
+    platformUrls?: Record<string, string>;
+    releaseDate: string;
+    isBeta?: boolean;
+    rolloutPercentage?: number;
+}
+interface VersionCheckResponse {
+    updateAvailable: boolean;
+    updateRequired: boolean;
+    updateRecommended: boolean;
+    updateType?: "major" | "minor" | "patch" | "hash" | "unknown";
+    latestVersion?: AppVersion;
+}
+interface VersionUpdateRules {
+    major?: "required" | "available";
+    minor?: "required" | "available";
+    patch?: "required" | "recommended" | "available";
+}
+interface AnalyticsConfig {
+    urlWhitelist?: string[];
+    urlBlacklist?: string[];
+    userWhitelist?: string[];
+    userBlacklist?: string[];
+    sampleRate?: number;
+    trackPageViews?: boolean;
+    trackWebVitals?: boolean;
+    trackOutboundLinks?: boolean;
+    trackSessionStart?: boolean;
+    flushInterval?: number;
+}
+interface SdkVersionRequirement {
+    packageName: string;
+    displayName: string;
+    currentVersion: string;
+    minimumVersion: string;
+    updateCommand: string;
+    changelog?: string;
+}
+interface SiteConfig {
+    maintenance: MaintenanceConfig;
+    messages: StatusMessage[];
+    featureFlags: FeatureFlag[];
+    lastUpdated: string;
+    analyticsConfig?: AnalyticsConfig | null;
+    sdkVersions?: SdkVersionRequirement[];
+}
+interface SiteManagerConfig {
+    apiKey: string;
+    projectId: string;
+    apiUrl?: string;
+    environment?: string;
+    pollInterval?: number;
+    userEmail?: string;
+    bypassCheck?: () => boolean;
+    onMaintenanceEnabled?: (config: MaintenanceConfig) => void;
+    onMaintenanceDisabled?: () => void;
+    onMessageReceived?: (message: StatusMessage) => void;
+    onMessageDismissed?: (messageId: string) => void;
+    onFeatureFlagsUpdated?: (flags: FeatureFlag[]) => void;
+    userId?: string;
+    customAttributes?: Record<string, string | number | boolean>;
+    bootstrapFlags?: Record<string, boolean>;
+    enableAnalytics?: boolean;
+    analyticsFlushInterval?: number;
+    appVersion?: string;
+    enableVersionCheck?: boolean;
+    versionCheckInterval?: number;
+    onUpdateAvailable?: (versionInfo: VersionCheckResponse) => void;
+    onUpdateRequired?: (versionInfo: VersionCheckResponse) => void;
+    platform?: string;
+    updateRules?: VersionUpdateRules;
+    onError?: (error: Error) => void;
+    debugMode?: boolean;
+    debugSecret?: string;
+    autoInjectBanners?: boolean;
+    autoCaptureClicks?: boolean;
+}
+declare class SiteManager {
+    private config;
+    private siteConfig;
+    private configETag;
+    private analyticsConfig;
+    private _sessionSampled;
+    private _sdkUpdateToastShown;
+    private pollIntervalId;
+    private versionCheckIntervalId;
+    private messageContainers;
+    private dismissedMessages;
+    private featureFlagBuckets;
+    private analyticsQueue;
+    private analyticsFlushIntervalId;
+    private sessionId;
+    private consecutiveFetchFailures;
+    private pageTrackingSetup;
+    private currentPagePath;
+    private currentPageSearch;
+    private pageEntryTime;
+    private static readonly MAX_CONSECUTIVE_FAILURES;
+    private lastVersionCheck;
+    private debugOverlayEl;
+    private debugRefreshId;
+    private debugLogs;
+    private networkLog;
+    private analyticsEventsSent;
+    private debugMinimized;
+    private debugTab;
+    private recentAnalyticsEvents;
+    private testFlagKey;
+    private testFeedback;
+    private errorCount;
+    private consoleIntercepted;
+    private visitorId;
+    private flagOverrides;
+    private originalConsoleError;
+    private originalConsoleWarn;
+    constructor(config: SiteManagerConfig);
+    init(): Promise<void>;
+    destroy(): void;
+    setUser(email: string, userId?: string, customAttributes?: Record<string, string | number | boolean>): void;
+    isFeatureEnabled(flagKey: string, defaultValue?: boolean): boolean;
+    getFeatureVariant(flagKey: string): string | null;
+    getAllFeatureFlags(): FeatureFlag[];
+    getEnabledFeatures(): string[];
+    getActiveEnvironment(): {
+        id: string;
+        name: string;
+        slug: string;
+    } | null;
+    isErrorLoggingEnabled(): boolean;
+    overrideFlag(flagKey: string, value: boolean | null): void;
+    isInMaintenanceMode(): boolean;
+    getActiveMessages(): StatusMessage[];
+    refresh(): Promise<void>;
+    private matchesPattern;
+    private matchesAnyPattern;
+    private isSessionSampled;
+    trackEvent(eventName: string, properties?: Record<string, string | number | boolean>): void;
+    track404(path?: string): void;
+    private fetchConfig;
+    private startPolling;
+    private stopPolling;
+    private startAnalyticsFlushing;
+    private stopAnalyticsFlushing;
+    private flushAnalytics;
+    private debugLog;
+    private debugNetwork;
+    private stopDebugOverlay;
+    private setupGlobalErrorCapture;
+    private setupDebugOverlay;
+    private renderDebugOverlay;
+    private handleTestAction;
+    private parseUtmParams;
+    private setupWebVitals;
+    private setupOutboundLinkTracking;
+    private setupAutoClickCapture;
+    private setupPageTracking;
+    private trackPageView;
+    private trackPageExit;
+    private onNavigate;
+    private generateSessionId;
+    private compareVersions;
+    private showSdkUpdateToast;
+    checkVersion(currentVersion?: string): Promise<VersionCheckResponse | null>;
+    forceUpdateWeb(): Promise<void>;
+    getLastVersionCheck(): VersionCheckResponse | null;
+    private startVersionChecking;
+    private stopVersionChecking;
+    private resolveEnvironment;
+    private hostnameMatchesEnv;
+    private matchHostnamePattern;
+    private evaluateFeatureFlag;
+    private getUserBucket;
+    private simpleHash;
+    private getAnonymousId;
+    private getOrCreateVisitorId;
+    private checkMaintenanceMode;
+    private enableMaintenanceMode;
+    private disableMaintenanceMode;
+    private shouldBypassMaintenance;
+    private showMaintenancePage;
+    private hideMaintenancePage;
+    private getDefaultMaintenanceHtml;
+    private updateMessages;
+    private showMessage;
+    private dismissMessage;
+    private clearMessages;
+    private handleMessageAction;
+    private getDefaultIcon;
+    private loadDismissedMessages;
+    private saveDismissedMessages;
+    private injectStyles;
+}
+
+export { type AnalyticsConfig, type AppVersion, type FeatureFlag, type MaintenanceConfig, type MessagePosition, type MessageStyle, type MessageType, SDK_VERSION, type SdkVersionRequirement, type SiteConfig, SiteManager, type SiteManagerConfig, type StatusMessage, type VersionCheckResponse, type VersionUpdateRules, SiteManager as default };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+declare const SDK_VERSION = "1.1.28";
 type MessageType = "info" | "warning" | "error" | "success";
 type MessagePosition = "top" | "bottom";
 type MessageStyle = "banner" | "toast";
@@ -76,11 +77,33 @@ interface VersionUpdateRules {
     minor?: "required" | "available";
     patch?: "required" | "recommended" | "available";
 }
+interface AnalyticsConfig {
+    urlWhitelist?: string[];
+    urlBlacklist?: string[];
+    userWhitelist?: string[];
+    userBlacklist?: string[];
+    sampleRate?: number;
+    trackPageViews?: boolean;
+    trackWebVitals?: boolean;
+    trackOutboundLinks?: boolean;
+    trackSessionStart?: boolean;
+    flushInterval?: number;
+}
+interface SdkVersionRequirement {
+    packageName: string;
+    displayName: string;
+    currentVersion: string;
+    minimumVersion: string;
+    updateCommand: string;
+    changelog?: string;
+}
 interface SiteConfig {
     maintenance: MaintenanceConfig;
     messages: StatusMessage[];
     featureFlags: FeatureFlag[];
     lastUpdated: string;
+    analyticsConfig?: AnalyticsConfig | null;
+    sdkVersions?: SdkVersionRequirement[];
 }
 interface SiteManagerConfig {
     apiKey: string;
@@ -117,6 +140,9 @@ declare class SiteManager {
     private config;
     private siteConfig;
     private configETag;
+    private analyticsConfig;
+    private _sessionSampled;
+    private _sdkUpdateToastShown;
     private pollIntervalId;
     private versionCheckIntervalId;
     private messageContainers;
@@ -166,6 +192,9 @@ declare class SiteManager {
     isInMaintenanceMode(): boolean;
     getActiveMessages(): StatusMessage[];
     refresh(): Promise<void>;
+    private matchesPattern;
+    private matchesAnyPattern;
+    private isSessionSampled;
     trackEvent(eventName: string, properties?: Record<string, string | number | boolean>): void;
     track404(path?: string): void;
     private fetchConfig;
@@ -190,6 +219,8 @@ declare class SiteManager {
     private trackPageExit;
     private onNavigate;
     private generateSessionId;
+    private compareVersions;
+    private showSdkUpdateToast;
     checkVersion(currentVersion?: string): Promise<VersionCheckResponse | null>;
     forceUpdateWeb(): Promise<void>;
     getLastVersionCheck(): VersionCheckResponse | null;
@@ -221,4 +252,4 @@ declare class SiteManager {
     private injectStyles;
 }
 
-export { type AppVersion, type FeatureFlag, type MaintenanceConfig, type MessagePosition, type MessageStyle, type MessageType, type SiteConfig, SiteManager, type SiteManagerConfig, type StatusMessage, type VersionCheckResponse, type VersionUpdateRules, SiteManager as default };
+export { type AnalyticsConfig, type AppVersion, type FeatureFlag, type MaintenanceConfig, type MessagePosition, type MessageStyle, type MessageType, SDK_VERSION, type SdkVersionRequirement, type SiteConfig, SiteManager, type SiteManagerConfig, type StatusMessage, type VersionCheckResponse, type VersionUpdateRules, SiteManager as default };