gio-uniapp-sdk 0.0.0-stage → 1.0.0

package/index.js

@@ -0,0 +1,175 @@
+import { createAppTracker } from './src/platform/index.js';
+import { SDK_VERSION, normalizeInitOptions } from './src/constants/config.js';
+import { createMiniProgramTracker, matchesMiniProgramAppId } from './src/platform/miniprogram.js';
+import { resolveRuntimeTarget } from './src/platform/resolve.js';
+import { isBuiltinPlugin, snapshotBuiltinPlugin } from './src/core/lifecycle.js';
+import { normalizeUniMPConfig } from './src/plugins/gioHybridAdapter/contract.js';
+import { createUniMPTracker } from './src/platform/unimp.js';
+import { installUniAppLifecycle } from './src/adapters/uniapp.js';
+import { guid } from './src/utils/tools.js';
+let singleton = null;
+let gdpTracker = null;
+let pendingGdpPlugins = [];
+/** App SDK 只创建单例；重复请求返回首次运行时，避免重复安装生命周期、队列、存储命名空间和上传器。 */
+function createGioTracker(host, options, target) {
+    if (singleton === null)
+        singleton = target === 'app' ? createAppTracker(host, options) : createMiniProgramTracker(host, target, options);
+    return singleton;
+}
+/** 将非数组对象视为参数记录，拒绝标量和空值。 */
+function record(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value)
+        ? value
+        : null;
+}
+/** 检查全局 uni 是否具备 App SDK 所需的宿主方法；缺失时拒绝初始化。 */
+function runtimeHost() {
+    const candidate = record(typeof uni === 'undefined' ? globalThis.uni : uni);
+    const required = ['getStorageSync', 'setStorageSync', 'removeStorageSync', 'getNetworkType', 'request'];
+    if (candidate === null || !required.every(name => typeof candidate[name] === 'function'))
+        return null;
+    const target = resolveRuntimeTarget(candidate, typeof __GIO_UNI_PLATFORM__ === 'undefined' ? undefined : __GIO_UNI_PLATFORM__);
+    if (target === null || (target === 'app' && !['getDeviceInfo', 'getSystemInfoSync', 'getAppBaseInfo'].every(name => typeof candidate[name] === 'function')))
+        return null;
+    return { host: candidate, target };
+}
+/** 确认传入的是可安装全局 mixin 的 Vue 应用。 */
+function isUniVueApp(value) {
+    const candidate = record(value);
+    return candidate !== null && typeof candidate.mixin === 'function';
+}
+/** 校验客户插件的名称和安装方法，不在此执行插件代码。 */
+function isCustomerPlugin(value) {
+    const candidate = record(value);
+    return candidate !== null && typeof candidate.name === 'string' && candidate.name.trim() !== '' && typeof candidate.install === 'function';
+}
+/** 取得插件声明的名称，供注册去重使用。 */
+function pluginName(plugin) {
+    return plugin.name;
+}
+/** 固定内置配置，同时保留兼具客户插件角色的安装方法和原对象上下文。 */
+function snapshotGdpPlugin(plugin) {
+    if (!isBuiltinPlugin(plugin))
+        return plugin;
+    const builtin = snapshotBuiltinPlugin(plugin);
+    return isCustomerPlugin(plugin)
+        ? Object.freeze({ ...builtin, install: plugin.install.bind(plugin) })
+        : builtin;
+}
+/** 在首次初始化前原子校验并暂存插件；重复名称或非法声明使整批失败。 */
+function registerGdpPlugins(value) {
+    if (!Array.isArray(value) || gdpTracker !== null)
+        return false;
+    const plugins = value.filter((plugin) => isBuiltinPlugin(plugin) || isCustomerPlugin(plugin));
+    if (plugins.length !== value.length)
+        return false;
+    const names = new Set(pendingGdpPlugins.map(pluginName));
+    for (const plugin of plugins) {
+        const name = pluginName(plugin);
+        if (names.has(name))
+            return false;
+        names.add(name);
+    }
+    pendingGdpPlugins = [...pendingGdpPlugins, ...plugins.map(snapshotGdpPlugin)];
+    return true;
+}
+/**
+ * 与独立小程序 SDK 对齐的命令入口。业务在 main.ts 注册插件，再将 Vue 应用作为 uniVue 传给 init。
+ * SDK 读取全局 uni 并自行转发生命周期，业务页面统一调用 gdp()。
+ *
+ * @returns 命令是否被本地接纳；事件命令成功不代表采集服务已接收。
+ */
+export const gdp = ((command, ...args) => {
+    if (command === 'registerPlugins')
+        return registerGdpPlugins(args[0]);
+    if (command === 'init') {
+        if (gdpTracker !== null && gdpTracker.canRetryInit()) {
+            // 上次初始化在异步恢复阶段失败：复用已安装的生命周期与插件，只重新校验配置并恢复状态。
+            if (typeof args[0] !== 'string' || typeof args[1] !== 'string')
+                return false;
+            const input = record(args[2]);
+            if (input === null || !isUniVueApp(input.uniVue) || input.runtime === 'unimp')
+                return false;
+            const { uniVue: _app, sdkVersion: _ignoredVersion, ...init } = input;
+            return gdpTracker.init({ ...init, accountId: args[0], dataSourceId: args[1] });
+        }
+        if (gdpTracker !== null) {
+            try {
+                globalThis.console?.warn('[GrowingIO]：SDK重复初始化，请检查是否重复加载SDK或接入其他平台SDK导致冲突!');
+            }
+            catch { /* 诊断输出异常不应打断后续业务调用。 */ }
+            return false;
+        }
+        if (typeof args[0] !== 'string' || typeof args[1] !== 'string')
+            return false;
+        const input = record(args[2]);
+        if (input === null || !isUniVueApp(input.uniVue))
+            return false;
+        const { uniVue, sdkVersion: _ignoredVersion, ...init } = input;
+        if (input.runtime === 'unimp') {
+            const value = { ...init, accountId: args[0], dataSourceId: args[1] };
+            if (normalizeUniMPConfig(value) === null || !pendingGdpPlugins.some(plugin => isBuiltinPlugin(plugin) && plugin.name === 'gioHybridAdapter')
+                || pendingGdpPlugins.some(plugin => isBuiltinPlugin(plugin) && plugin.name === 'gioNativeIdentifiers'))
+                return false;
+            const host = record(typeof uni === 'undefined' ? globalThis.uni : uni) ?? {};
+            // 不要求本地 App 的存储 / 请求 / 系统 API；缺少 module 在首次前台握手时报告。
+            const tracker = createUniMPTracker(host);
+            if (!tracker.registerPlugins(...pendingGdpPlugins.filter(isBuiltinPlugin)) || !tracker.init(value))
+                return false;
+            singleton = tracker;
+            gdpTracker = tracker;
+            installUniAppLifecycle(uniVue, tracker, { host, unimp: true });
+            installCustomerPlugins(tracker);
+            return true;
+        }
+        const runtime = runtimeHost();
+        if (runtime === null || pendingGdpPlugins.some(plugin => isBuiltinPlugin(plugin) && plugin.name === 'gioHybridAdapter'))
+            return false;
+        const { host, target } = runtime;
+        if (target !== 'app' && pendingGdpPlugins.some(plugin => isBuiltinPlugin(plugin) && plugin.name === 'gioNativeIdentifiers'))
+            return false;
+        const config = normalizeInitOptions({ ...init, accountId: args[0], dataSourceId: args[1] }, target === 'app' ? undefined : target);
+        if (!config.ok || (config.config.miniprogram !== undefined && !matchesMiniProgramAppId(host, config.config.miniprogram.appId)))
+            return false;
+        const tracker = createGioTracker(host, {
+            sdkVersion: SDK_VERSION,
+            deviceIdFactory: guid,
+            sessionIdFactory: guid,
+        }, target);
+        const registered = new Set(tracker.registeredPluginNames());
+        const builtinPlugins = pendingGdpPlugins.filter(isBuiltinPlugin).filter((plugin) => !registered.has(plugin.name));
+        if (!tracker.registerPlugins(...builtinPlugins) || !tracker.init({ ...init, accountId: args[0], dataSourceId: args[1] }))
+            return false;
+        installUniAppLifecycle(uniVue, tracker, { host, miniprogram: target === 'app' ? undefined : target });
+        gdpTracker = tracker;
+        installCustomerPlugins(tracker);
+        return true;
+    }
+    if (gdpTracker === null)
+        return command === 'getGioInfo' ? null : false;
+    switch (command) {
+        case 'track': return gdpTracker.track(args[0], args[1]);
+        case 'setUserId': return gdpTracker.setUserId(args[0], args[1]);
+        case 'clearUserId': return gdpTracker.clearUserId();
+        case 'identify': return gdpTracker.identify(args[0]);
+        case 'getGioInfo': return gdpTracker.getGioInfo();
+        case 'setUserAttributes': return gdpTracker.setUserAttributes(args[0]);
+        case 'setOptions': return gdpTracker.setOptions(args[0]);
+        case 'setLocation': return gdpTracker.setLocation(args[0], args[1]);
+        case 'clearLocation': return gdpTracker.clearLocation();
+        default: return false;
+    }
+});
+function installCustomerPlugins(tracker) {
+    for (const plugin of pendingGdpPlugins.filter(isCustomerPlugin)) {
+        try {
+            plugin.install(tracker);
+        }
+        catch {
+            globalThis.console?.warn(`[GrowingIO]: custom plugin install failed (${plugin.name})`);
+        }
+    }
+}
+;
+globalThis.gdp = gdp;
+export default gdp;

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "gio-uniapp-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "GrowingIO 传统 uni-app Vue 3 数据采集 SDK，本期仅发布鸿蒙端",
+  "type": "module",
+  "private": false,
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/growingio/growingio-sdk-uniapp-autotracker.git"
+  },
+  "keywords": [
+    "growingio",
+    "uni-app",
+    "uni_modules",
+    "analytics",
+    "tracking",
+    "埋点",
+    "统计"
+  ],
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./vite": {
+      "types": "./vite.d.ts",
+      "import": "./vite.js"
+    },
+    "./autotrack": {
+      "types": "./autotrack.d.ts",
+      "import": "./autotrack.js"
+    }
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "src",
+    "README.md",
+    "LICENSE",
+    "THIRD_PARTY_LICENSES.txt"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/src/adapters/uniapp.d.ts

@@ -0,0 +1,66 @@
+import type { AppEntrySnapshot } from '../core/dataStore/app.js';
+import type { PageLoadInput } from '../core/dataStore/page.js';
+import type { AutoTrackCall } from '../plugins/gioEventAutoTracking/contract.js';
+import type { MiniProgramTarget } from '../types/index.js';
+type LifecycleTarget = AppLifecycleTarget & PageLifecycleTarget;
+export type UniAppVueApp = Readonly<{
+    /** 将 SDK 生命周期转发器安装到全局 Vue mixin。 */
+    mixin: (options: Readonly<Record<string, unknown>>) => void;
+}>;
+/** 安装一个全局 Vue mixin，以 WeakMap 保存宿主页面与桥接器的对应关系；核心仅接收路由、query 和标题快照。 */
+export declare function installUniAppLifecycle(app: UniAppVueApp, target: LifecycleTarget, options?: Readonly<{
+    host?: unknown;
+    miniprogram?: MiniProgramTarget;
+    unimp?: boolean;
+}>): void;
+export interface AppLifecycleTarget {
+    /** 接纳 App 启动入口快照，建立冷启动边界。 */
+    onAppLaunch(entry: AppEntrySnapshot): boolean;
+    /** 接纳前台入口快照，按会话规则决定是否生成 VISIT。 */
+    onAppShow(entry: AppEntrySnapshot): boolean;
+    /** 接纳后台观察，尽力生成关闭事件并刷新队列。 */
+    onAppHide(): boolean;
+}
+/** App 和 Page 桥接共用 query 序列化规则，避免保留原始宿主参数对象。 */
+export declare function querySnapshot(value: unknown): string | null;
+/** 将 App 生命周期参数裁剪为纯 JSON 入口，省略不支持的 query 值。 */
+export declare function appEntrySnapshot(options: unknown, target?: MiniProgramTarget): AppEntrySnapshot;
+/** 为 App 的三个生命周期钩子提供桥接，不将宿主或 Vue 对象传入核心。 */
+export declare function createAppLifecycleBridge(target: AppLifecycleTarget): Readonly<{
+    /** 裁剪宿主启动参数后转发给运行时。 */
+    onLaunch: (options: unknown) => boolean;
+    /** 转发显示状态及当前入口或页面标题。 */
+    onShow: (options: unknown) => boolean;
+    /** 转发隐藏状态，由对应生命周期决定影响范围。 */
+    onHide: () => boolean;
+}>;
+export interface PageLifecycleTarget {
+    /** 登记由页面实例绑定的路由、query 和来源快照。 */
+    onPageLoad(input: PageLoadInput): boolean;
+    /** 更新该页面实例的显示时间与可选标题。 */
+    onPageShow(instanceId: string, title: string | null): boolean;
+    /** 清除该实例的当前页面关联。 */
+    onPageHide(instanceId: string): boolean;
+    /** 释放该页面实例的状态。 */
+    onPageUnload(instanceId: string): boolean;
+    /** 可选标题增强，只更新指定页面快照。 */
+    onPageTitleChanged?(instanceId: string, title: string): boolean;
+    /** 可选自动采集入口，由运行时继续执行全部门控。 */
+    autoTrack?(call: AutoTrackCall): boolean;
+}
+/** 将宿主页面实例绑定到稳定标识，调用方只提交快照，不传入 Vue 或 Page 对象。 */
+export declare function createPageLifecycleBridge(target: PageLifecycleTarget, instanceId: string, miniprogram?: MiniProgramTarget): Readonly<{
+    /** 将宿主页面参数转换为纯数据后提交。 */
+    onLoad: (route: unknown, query: unknown, referralPage?: unknown) => boolean;
+    /** 转发显示状态及当前入口或页面标题。 */
+    onShow: (title?: unknown) => boolean;
+    /** 转发隐藏状态，由对应生命周期决定影响范围。 */
+    onHide: () => boolean;
+    /** 转发绑定实例的卸载通知。 */
+    onUnload: () => boolean;
+    /** 规范 tabBar 点击并提交版本化探针。 */
+    onTabItemTap: (options: unknown) => boolean;
+    /** 更新绑定页面的标题，不模拟导航。 */
+    onTitleChanged: (title: string) => boolean | undefined;
+}>;
+export {};