@metricinsights/pp-dev 1.5.0-beta.25 → 1.5.0-beta.27

package/dist/types/pp-dev-config-D889A-PO.d.ts

@@ -0,0 +1,189 @@
+import { ViteImageOptimizer } from 'vite-plugin-image-optimizer';
+
+/**
+ * pp-dev's config: its public types, validation and normalization.
+ *
+ * Kept free of the dev server's dependencies (express, axios, the proxy, jsdom, …): `withPPDev()`
+ * runs while Next.js evaluates next.config, and the CLI reads the config before it knows whether
+ * it will serve, so loading the config must not load the server.
+ */
+
+type MiMode = 'standalone' | 'embedding';
+type MiInclude = 'shared-components' | 'top-bar';
+type AppType = 'page' | 'template';
+interface MiConfig {
+    /** MI instance base URL. Falls back to process.env.MI_BACKEND_URL. */
+    url?: string;
+    /** Personal Access Token. Falls back to process.env.MI_ACCESS_TOKEN. */
+    token?: string;
+    /** How the page integrates into MI. @default 'standalone' */
+    mode?: MiMode;
+    /** Optional MI shared resources. Only valid when mode === 'standalone'. */
+    include?: MiInclude;
+    /** MI API/routing version. @default 7 */
+    apiVersion?: 6 | 7;
+}
+interface AppConfig {
+    /** Portal page / app ID on MI. Required for type=template and type=page+standalone. */
+    id?: number;
+    /** Internal asset name. @default package.json#name */
+    name?: string;
+    /** App type affecting routing and data loading. @default 'template' */
+    type?: AppType;
+}
+interface ProxyConfig {
+    /** Enable request caching to the backend. @default true */
+    cache?: boolean;
+    /** Cache TTL in milliseconds. @default 600000 */
+    cacheTtl?: number;
+    tls?: {
+        /** Allow self-signed TLS certificates. @default false */
+        allowSelfSigned?: boolean;
+    };
+}
+interface DistZipBuildConfig {
+    /** Output ZIP file name. @default '<app.name>.zip' */
+    fileName?: string;
+    /** Output directory for the ZIP archive. @default 'dist-zip' */
+    outDir?: string;
+    /** Input directory to zip. @default value of build.outDir */
+    inDir?: string;
+}
+interface VersionFileBuildConfig {
+    /** @default true */
+    enabled?: boolean;
+    /** @default 'VERSION-v{packageversion}-{currentDate}.json' */
+    fileNameTemplate?: string;
+}
+interface BuildConfig {
+    /** Build output directory. @default 'dist' */
+    outDir?: string;
+    /** Pack build output into a ZIP archive. @default true */
+    zip?: boolean | DistZipBuildConfig;
+    /** Create a VERSION JSON file with SHA256 hashes. @default true */
+    versionFile?: boolean | VersionFileBuildConfig;
+    /** Image optimisation options. @default true */
+    imageOptimisations?: boolean | Record<string, unknown>;
+}
+interface SyncConfig {
+    /** Directory for sync backups. @default 'backups' */
+    backupsDir?: string;
+    /**
+     * How many backups of this page to keep; each new backup deletes the oldest beyond that.
+     * `false` or `0` keeps them all. @default 20
+     */
+    maxBackups?: number | false;
+    /**
+     * How long the build a sync starts (`pp-dev build`, `next build`) may run, in milliseconds,
+     * before it is stopped and the sync fails. @default 600000 (10 minutes)
+     */
+    buildTimeoutMs?: number;
+}
+interface InspectorConfig {
+    /** Enable the request inspector web UI at /@pp-dev/inspector. @default true */
+    enabled?: boolean;
+    /** Maximum RAM for stored request/response payloads in bytes. @default 1073741824 (1 GB) */
+    maxMemory?: number;
+    /** Maximum bytes captured per individual request/response body. @default 10485760 (10 MB) */
+    captureLimit?: number;
+}
+type DevPanelPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+interface DevPanelConfig {
+    /** Screen corner the dev panel is anchored to. @default 'bottom-right' */
+    position?: DevPanelPosition;
+    /** Fully hide the panel. Restore in the browser with ?pp-dev-panel=show. @default false */
+    hidden?: boolean;
+    /** Auto-hide: the panel slides behind the screen edge leaving a thin strip; hover reveals it. @default false */
+    autoHide?: boolean;
+}
+interface UsersConfig {
+    /**
+     * Keep the users added with an API token between dev server runs, in a file in your home
+     * directory (`~/.pp-dev/users/`) that only you can read. Passwords and MI sessions are never kept.
+     * @default false
+     */
+    persist?: boolean;
+}
+interface ServerConfig {
+    /**
+     * Host names the dev server answers besides `localhost`, `*.localhost` and IP addresses, as
+     * Vite's `server.allowedHosts`: `'my-app.ngrok.app'`, or `'.ngrok.app'` for that domain and its
+     * subdomains. Any other `Host` is refused (DNS rebinding). The value of `--host` is allowed too.
+     * Pages on the names listed without a leading dot may also use the dev server's API, its
+     * WebSocket and, under `pp-dev next`, Next's HMR (`withPPDev()` adds them to Next's
+     * `allowedDevOrigins` in development): a page through a tunnel. `true` answers any host; avoid it.
+     * @default []
+     */
+    allowedHosts?: string[] | true;
+}
+interface PPDevConfig {
+    mi?: MiConfig;
+    app?: AppConfig;
+    proxy?: ProxyConfig;
+    build?: BuildConfig;
+    sync?: SyncConfig;
+    inspector?: InspectorConfig;
+    devPanel?: DevPanelConfig;
+    /** Working as other MI users (the dev panel's Users section). */
+    users?: UsersConfig;
+    /** The dev server itself (`pp-dev` and `pp-dev next`). */
+    server?: ServerConfig;
+}
+interface VersionPluginOptions {
+    /**
+     * Version file filename template.
+     * Placeholders: {packageversion}, {currentDate}
+     * @default "VERSION-v{packageversion}-{currentDate}.json"
+     */
+    versionFileTemplate?: string;
+    /** @default true */
+    enabled?: boolean;
+}
+/** @internal — used by the Vite plugin and CLI; not part of the public API. */
+interface NormalizedVitePPDevOptions {
+    templateName: string;
+    backendBaseURL?: string;
+    appId?: number;
+    templateLess: boolean;
+    miHudLess: boolean;
+    integrateMiTopBar: boolean | {
+        addRootElement?: boolean;
+        addSharedComponentsScripts?: boolean;
+    };
+    enableProxyCache: boolean;
+    proxyCacheTTL: number;
+    disableSSLValidation: boolean;
+    imageOptimizer: boolean | Parameters<typeof ViteImageOptimizer>[0];
+    outDir: string;
+    distZip: false | {
+        outFileName: string;
+        outDir: string;
+        inDir?: string;
+    };
+    versionPlugin: false | VersionPluginOptions;
+    syncBackupsDir: string;
+    /** `undefined` leaves DistService's default. */
+    syncMaxBackups?: number | false;
+    /** `undefined` leaves DistService's default. */
+    syncBuildTimeoutMs?: number;
+    v7Features: boolean;
+    personalAccessToken?: string;
+    inspectorEnabled: boolean;
+    inspectorMaxMemory: number;
+    inspectorCaptureLimit: number;
+    devPanelPosition: DevPanelPosition;
+    devPanelHidden: boolean;
+    devPanelAutoHide: boolean;
+    persistUsers: boolean;
+    /** `server.allowedHosts`, lowercased. */
+    allowedHosts: string[] | true;
+}
+/**
+ * @param templateName - package.json's `name`; `app.name` takes precedence over it, here and in
+ *   {@link normalizePPDevConfig} (whose `templateName` is the one name to use from then on).
+ */
+declare function validatePPDevConfig(config: PPDevConfig, templateName: string | undefined): void;
+declare function normalizePPDevConfig(config: PPDevConfig, templateName: string | undefined): NormalizedVitePPDevOptions;
+
+export { normalizePPDevConfig as n, validatePPDevConfig as v };
+export type { AppConfig as A, BuildConfig as B, DevPanelConfig as D, InspectorConfig as I, MiConfig as M, NormalizedVitePPDevOptions as N, PPDevConfig as P, SyncConfig as S, UsersConfig as U, VersionPluginOptions as V, AppType as a, DevPanelPosition as b, MiInclude as c, MiMode as d, ProxyConfig as e, ServerConfig as f };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metricinsights/pp-dev",
   "type": "module",
-  "version": "1.5.0-beta.25",
+  "version": "1.5.0-beta.27",
   "description": "Portal Page dev build tool",
   "bin": {
     "pp-dev": "bin/pp-dev.js"
@@ -29,8 +29,9 @@
     "test:integration:watch": "vitest --config vitest.integration.config.ts",
     "test:e2e:ui": "npx playwright test --ui",
     "test:all": "npm run test:unit && npm run test:integration",
-    "lint": "eslint src tests",
-    "lint:fix": "eslint src tests --fix",
+    "lint": "eslint src tests e2e",
+    "lint:fix": "eslint src tests e2e --fix",
+    "typecheck": "tsc --noEmit -p tsconfig.json && tsc -p tests/tsconfig.json && tsc -p e2e/tsconfig.json",
     "audit:all": "node scripts/audit-all.mjs",
     "prereinstall:all": "npm run build",
     "reinstall:all": "node scripts/reinstall-all.mjs"
@@ -155,17 +156,13 @@
     "dist",
     "package.json",
     "README.md",
-    "LICENSE.md",
+    "LICENSE",
     "pp-dev.d.ts",
-    "assets",
     "CHANGELOG.md",
     "TEMPLATE_VARIABLES.md",
     "docs/features.md",
     "docs/screenshots"
   ],
-  "directories": {
-    "test": "test"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mi-examples/pp-dev.git"