@weapp-core/api 0.1.0

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@weapp-core/api",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "Framework-agnostic cross-platform mini-program API proxy",
+  "author": "ice breaker <1324318532@qq.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/weapp-vite/weapp-vite#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weapp-vite/weapp-vite.git",
+    "directory": "@weapp-core/api"
+  },
+  "bugs": {
+    "url": "https://github.com/weapp-vite/weapp-vite/issues"
+  },
+  "keywords": [
+    "mini-program",
+    "miniprogram",
+    "cross-platform",
+    "api",
+    "adapter",
+    "weapp"
+  ],
+  "sideEffects": false,
+  "weapp-vite-dev": {
+    "exports": {
+      ".": {
+        "types": "./src/index.ts",
+        "default": "./src/index.ts"
+      }
+    },
+    "main": "./src/index.ts",
+    "module": "./src/index.ts",
+    "types": "./src/index.ts"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./types/index.d.ts",
+  "files": [
+    "README.md",
+    "dist",
+    "types"
+  ],
+  "dependencies": {
+    "@douyin-microapp/typings": "^1.3.1",
+    "@mini-types/alipay": "^3.0.14",
+    "miniprogram-api-typings": "^5.2.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "tsdown -w",
+    "build": "tsdown",
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "pretest:types": "pnpm build",
+    "test:types": "tsd",
+    "release": "pnpm publish",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "catalog:sync": "node ./scripts/sync-api-catalog.mjs",
+    "catalog:check": "node ./scripts/sync-api-catalog.mjs --check",
+    "strict-alias:check": "node --import tsx ./scripts/check-strict-alias-guard.mjs",
+    "omittable-option:check": "node ./scripts/check-omittable-option-guard.mjs",
+    "coverage:check": "node --import tsx ./scripts/check-coverage-guard.mjs",
+    "callback-types:check": "node ./scripts/check-callback-types.mjs",
+    "promise-types:check": "node ./scripts/check-promise-types.mjs",
+    "structure:check": "node ./scripts/check-structure-guard.mjs",
+    "strict-alias:scan": "node --import tsx ./scripts/scan-strict-alias-candidates.mjs",
+    "docs:sync": "node --import tsx ./scripts/sync-support-matrix.ts",
+    "docs:check": "node --import tsx ./scripts/sync-support-matrix.ts --check",
+    "report:api": "node --import tsx ./scripts/generate-api-report.mjs",
+    "prebuild": "pnpm run structure:check && pnpm run typecheck && pnpm run typecheck:test && pnpm run catalog:check && pnpm run docs:check && pnpm run strict-alias:check && pnpm run omittable-option:check && pnpm run coverage:check",
+    "postbuild": "pnpm run callback-types:check && pnpm run promise-types:check",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "typecheck:test": "tsc --noEmit -p tsconfig.test.json"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,189 @@
+/// <reference types="miniprogram-api-typings" />
+/// <reference types="@mini-types/alipay" />
+/// <reference types="@douyin-microapp/typings" />
+
+// eslint-disable-next-line antfu/no-import-dist
+import type {
+  CreateWeapiOptions,
+  MiniProgramApiPlatformDescriptor,
+  WeapiAdapter,
+  WeapiAlipayAdapter,
+  WeapiAlipayMethodName,
+  WeapiAlipayMiniProgramRawAdapterSource,
+  WeapiAlipayRawAdapter,
+  WeapiCrossPlatformAdapter,
+  WeapiCrossPlatformRawAdapter,
+  WeapiDefaultMiniProgramRawAdapterSource,
+  WeapiDouyinAdapter,
+  WeapiDouyinMethodName,
+  WeapiDouyinMiniProgramRawAdapterSource,
+  WeapiDouyinRawAdapter,
+  WeapiError,
+  WeapiInstance,
+  WeapiMethodSupportQueryOptions,
+  WeapiMiniProgramAdapter,
+  WeapiMiniProgramAlipayAdapter,
+  WeapiMiniProgramAlipayMethodName,
+  WeapiMiniProgramAlipayRawAdapter,
+  WeapiMiniProgramBluetoothError,
+  WeapiMiniProgramClipboardDataResult,
+  WeapiMiniProgramConnectSocketOption,
+  WeapiMiniProgramCrossPlatformAdapter,
+  WeapiMiniProgramCrossPlatformRawAdapter,
+  WeapiMiniProgramDouyinAdapter,
+  WeapiMiniProgramDouyinMethodName,
+  WeapiMiniProgramDouyinRawAdapter,
+  WeapiMiniProgramGeneralCallbackResult,
+  WeapiMiniProgramLogManager,
+  WeapiMiniProgramMethodName,
+  WeapiMiniProgramPlatformRawAdapterSourceName,
+  WeapiMiniProgramPlatformRawAdapterSourceRegistry,
+  WeapiMiniProgramRawAdapter,
+  WeapiMiniProgramRawAdapterSourceName,
+  WeapiMiniProgramRequestFailResult,
+  WeapiMiniProgramRequestMethod,
+  WeapiMiniProgramRequestOption,
+  WeapiMiniProgramRequestSuccessResult,
+  WeapiMiniProgramRequestTask,
+  WeapiMiniProgramRuntimeRawAdapterSourceName,
+  WeapiMiniProgramRuntimeRawAdapterSourceRegistry,
+  WeapiMiniProgramSelectorQuery,
+  WeapiMiniProgramSocketTask,
+  WeapiMiniProgramSystemInfo,
+  WeapiMiniProgramUpdateManager,
+  WeapiMiniProgramVideoContext,
+  WeapiMiniProgramWechatMethodName,
+  WeapiMiniProgramWechatRawAdapter,
+  WeapiMiniProgramWxAdapter,
+  WeapiMiniProgramWxMethodName,
+  WeapiMiniProgramWxRawAdapter,
+  WeapiPlatformTypeSourceName,
+  WeapiPromise,
+  WeapiPromisify,
+  WeapiResolvedTarget,
+  WeapiRuntimeTypeSourceName,
+  WeapiSupportLevel,
+  WeapiTtMiniProgramRawAdapterSource,
+  WeapiTypeSourceName,
+  WeapiWechatMethodName,
+  WeapiWechatMiniProgramRawAdapterSource,
+  WeapiWechatRawAdapter,
+  WeapiWxAdapter,
+  WeapiWxMethodName,
+  WeapiWxRawAdapter,
+} from '../dist/index.d.mts'
+
+export declare const WEAPI_PLATFORM_TYPE_SOURCES: typeof import('../dist/index.mjs').WEAPI_PLATFORM_TYPE_SOURCES
+export declare const WEAPI_RUNTIME_TYPE_SOURCES: typeof import('../dist/index.mjs').WEAPI_RUNTIME_TYPE_SOURCES
+export declare const WEAPI_TYPE_SOURCES: typeof import('../dist/index.mjs').WEAPI_TYPE_SOURCES
+export declare const MINI_PROGRAM_API_PLATFORM_DESCRIPTORS: typeof import('../dist/index.mjs').MINI_PROGRAM_API_PLATFORM_DESCRIPTORS
+
+export function normalizeMiniProgramPlatform(value?: string | null): string | undefined
+export function resolveMiniProgramPlatform(value?: string | null): MiniProgramApiPlatformDescriptor | undefined
+
+export type {
+  CreateWeapiOptions,
+  MiniProgramApiPlatformDescriptor,
+  WeapiAdapter,
+  WeapiAlipayAdapter,
+  WeapiAlipayMethodName,
+  WeapiAlipayMiniProgramRawAdapterSource,
+  WeapiAlipayRawAdapter,
+  WeapiCrossPlatformAdapter,
+  WeapiCrossPlatformRawAdapter,
+  WeapiDefaultMiniProgramRawAdapterSource,
+  WeapiDouyinAdapter,
+  WeapiDouyinMethodName,
+  WeapiDouyinMiniProgramRawAdapterSource,
+  WeapiDouyinRawAdapter,
+  WeapiError,
+  WeapiInstance,
+  WeapiMethodSupportQueryOptions,
+  WeapiMiniProgramAdapter,
+  WeapiMiniProgramAlipayAdapter,
+  WeapiMiniProgramAlipayMethodName,
+  WeapiMiniProgramAlipayRawAdapter,
+  WeapiMiniProgramBluetoothError,
+  WeapiMiniProgramClipboardDataResult,
+  WeapiMiniProgramConnectSocketOption,
+  WeapiMiniProgramCrossPlatformAdapter,
+  WeapiMiniProgramCrossPlatformRawAdapter,
+  WeapiMiniProgramDouyinAdapter,
+  WeapiMiniProgramDouyinMethodName,
+  WeapiMiniProgramDouyinRawAdapter,
+  WeapiMiniProgramGeneralCallbackResult,
+  WeapiMiniProgramLogManager,
+  WeapiMiniProgramMethodName,
+  WeapiMiniProgramPlatformRawAdapterSourceName,
+  WeapiMiniProgramPlatformRawAdapterSourceRegistry,
+  WeapiMiniProgramRawAdapter,
+  WeapiMiniProgramRawAdapterSourceName,
+  WeapiMiniProgramRequestFailResult,
+  WeapiMiniProgramRequestMethod,
+  WeapiMiniProgramRequestOption,
+  WeapiMiniProgramRequestSuccessResult,
+  WeapiMiniProgramRequestTask,
+  WeapiMiniProgramRuntimeRawAdapterSourceName,
+  WeapiMiniProgramRuntimeRawAdapterSourceRegistry,
+  WeapiMiniProgramSelectorQuery,
+  WeapiMiniProgramSocketTask,
+  WeapiMiniProgramSystemInfo,
+  WeapiMiniProgramUpdateManager,
+  WeapiMiniProgramVideoContext,
+  WeapiMiniProgramWechatMethodName,
+  WeapiMiniProgramWechatRawAdapter,
+  WeapiMiniProgramWxAdapter,
+  WeapiMiniProgramWxMethodName,
+  WeapiMiniProgramWxRawAdapter,
+  WeapiPlatformTypeSourceName,
+  WeapiPromise,
+  WeapiPromisify,
+  WeapiResolvedTarget,
+  WeapiRuntimeTypeSourceName,
+  WeapiSupportLevel,
+  WeapiTtMiniProgramRawAdapterSource,
+  WeapiTypeSourceName,
+  WeapiWechatMethodName,
+  WeapiWechatMiniProgramRawAdapterSource,
+  WeapiWechatRawAdapter,
+  WeapiWxAdapter,
+  WeapiWxMethodName,
+  WeapiWxRawAdapter,
+}
+
+export function createWeapi<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>(
+  options?: CreateWeapiOptions<TAdapter>,
+): WeapiInstance<TAdapter>
+
+export const createApi: typeof createWeapi
+
+export type CreateApiOptions<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>
+  = CreateWeapiOptions<TAdapter>
+
+export type MiniProgramApiInstance<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>
+  = WeapiInstance<TAdapter>
+
+export type WeapiDefaultInstance = WeapiInstance<WeapiCrossPlatformRawAdapter>
+
+/**
+ * 默认跨平台 API 实例。
+ *
+ * @generated weapi-platform-matrix:start
+ * | 平台 | 全局对象 | 类型来源 | 对齐状态 |
+ * | --- | --- | --- | --- |
+ * | 微信小程序 | `wx` | `miniprogram-api-typings` | ✅ 全量 |
+ * | 支付宝小程序 | `my` | `@mini-types/alipay` | ✅ 全量 |
+ * | 百度智能小程序 | `swan` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 抖音小程序 | `tt` | `@douyin-microapp/typings` | ✅ 全量 |
+ * | QQ 小程序 | `qq` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 快手小程序 | `ks` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 京东小程序 | `jd` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 小红书小程序 | `xhs` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 钉钉小程序 | `dd` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 快应用 | `qa` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | 快应用 WebView | `qapp` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * | uni-app 运行时 | `uni` | 运行时透传 | ⚠️ 按宿主能力支持 |
+ * @generated weapi-platform-matrix:end
+ */
+export const api: WeapiDefaultInstance
+export const wpi: WeapiDefaultInstance