@qmuse/appwrite-runtime-sdk 1.0.5-dev.1 → 1.0.5-dev.3

package/README.md

@@ -199,57 +199,42 @@ export function TodoList() {
 
 ## Taro 项目
 
-Taro 项目通过 `createPortableAppwriteClients()` 使用同一套 Runtime API。该方式适用于 Taro H5、支付宝小程序和微信小程序。
+Taro 项目通过 `createQmuseAppwriteRuntime()` 使用同一套 Runtime API，SDK 会在内部创建跨端客户端。该方式适用于 Taro H5、支付宝小程序和微信小程序。
+
+Taro 的跨端客户端模式必须从构建环境传入 `appwriteConfig`，SDK 不会请求 `/runtime/appwrite/config`。React Web 应用原有的动态配置流程不受影响。
 
 ### 1. 配置跨端环境变量
 
 在 Taro 的 `.env.development` 和 `.env.production` 中按目标环境配置：
 
 ```dotenv
-TARO_APP_QMUSE_APP_ID=3789326422662181
-TARO_APP_QMUSE_RUNTIME_ENV=dev
-TARO_APP_QMUSE_RUNTIME_DOMAIN=https://appio-pre.qmuse.cn
+QMUSE_APP_ID=3789326422662181
+QMUSE_RUNTIME_ENV=dev
+QMUSE_RUNTIME_DOMAIN=https://appio-pre.qmuse.cn
+QMUSE_APPWRITE_ENDPOINT=https://appbase-qmuse.oceanbase.com/v1
+QMUSE_APPWRITE_PROJECT_ID=6a8e99ba000a9dc3fe53
+QMUSE_APPWRITE_DATABASE_ID=qmuse-app-db
 ```
 
 补充环境变量类型：
 
 ```ts
 // types/global.d.ts
-interface QMuseRuntimeConfig {
-  appId: string;
-  env: 'dev' | 'prod';
-  domain: string;
-}
-
 declare namespace NodeJS {
   interface ProcessEnv {
-    TARO_APP_QMUSE_APP_ID: string;
-    TARO_APP_QMUSE_RUNTIME_ENV: 'dev' | 'prod';
-    TARO_APP_QMUSE_RUNTIME_DOMAIN: string;
+    QMUSE_APP_ID: string;
+    QMUSE_RUNTIME_ENV: 'dev' | 'prod';
+    QMUSE_RUNTIME_DOMAIN: string;
+    QMUSE_APPWRITE_ENDPOINT: string;
+    QMUSE_APPWRITE_PROJECT_ID: string;
+    QMUSE_APPWRITE_DATABASE_ID: string;
   }
 }
 ```
 
-### 2. 读取固定运行时配置
-
-```ts
-// src/runtime/qmuse.ts
-import type { QmuseRuntimeContext } from '@qmuse/appwrite-runtime-sdk';
-
-const runtimeConfig: QmuseRuntimeContext = Object.freeze({
-  appId: process.env.TARO_APP_QMUSE_APP_ID,
-  env: process.env.TARO_APP_QMUSE_RUNTIME_ENV,
-  domain: process.env.TARO_APP_QMUSE_RUNTIME_DOMAIN,
-});
-
-export function getMuseRuntimeConfig(): QmuseRuntimeContext {
-  return runtimeConfig;
-}
-```
-
-使用 `TARO_APP_*` 环境变量可以让 Taro 在 dev 和 build 命令中为 H5、支付宝和微信产物使用同一套注入方式。
+所有 Taro dev/build 命令都需要增加 `--env-prefix QMUSE_`。上述配置会编译进客户端产物，只能存放公开连接信息，禁止写入 Appwrite API Key、Custom Token secret 或用户 Session。
 
-### 3. 提供跨端请求与存储
+### 2. 提供跨端请求与存储
 
 H5 可以使用浏览器 `fetch`，小程序端需要将 `Taro.request` 适配为 SDK 接收的 `fetch` 接口：
 
@@ -327,33 +312,43 @@ export const platformStorage = {
 };
 ```
 
-### 4. 创建 Taro Runtime 单例
+### 3. 创建 Taro Runtime 单例
 
 ```ts
 // src/services/appwrite.ts
 import { ID, Permission, Query, Role } from 'appwrite';
 import {
-  createPortableAppwriteClients,
   createQmuseAppwriteRuntime,
+  type AppwriteRuntimeConfig,
   type Models,
+  type QmuseRuntimeContext,
 } from '@qmuse/appwrite-runtime-sdk';
-import { getMuseRuntimeConfig } from '../runtime/qmuse';
 import { platformFetch, platformStorage } from './platform';
 
+function getMuseRuntime(): QmuseRuntimeContext {
+  return {
+    appId: process.env.QMUSE_APP_ID,
+    env: process.env.QMUSE_RUNTIME_ENV,
+    domain: process.env.QMUSE_RUNTIME_DOMAIN,
+  };
+}
+
+const appwriteConfig: AppwriteRuntimeConfig = {
+  endpoint: process.env.QMUSE_APPWRITE_ENDPOINT,
+  projectId: process.env.QMUSE_APPWRITE_PROJECT_ID,
+  databaseId: process.env.QMUSE_APPWRITE_DATABASE_ID,
+};
+
 function getQmuseLoginUserId(): string | null {
   return null;
 }
 
-const clients = createPortableAppwriteClients({
-  fetch: platformFetch,
-  storage: platformStorage,
-});
-
 const runtime = createQmuseAppwriteRuntime({
-  ...clients,
-  getMuseRuntime: getMuseRuntimeConfig,
+  appwriteConfig,
+  getMuseRuntime,
   getQmuseLoginUserId,
   fetch: platformFetch,
+  storage: platformStorage,
 });
 
 export const initAppwrite = runtime.init;
@@ -370,7 +365,7 @@ export type { Models };
 export { ID, Permission, Query, Role };
 ```
 
-### 5. 在 Taro 应用启动时初始化
+### 4. 在 Taro 应用启动时初始化
 
 ```tsx
 // src/app.tsx
@@ -465,7 +460,7 @@ await deleteQmuseRow({
 ## 接入约束
 
 - 每个应用只创建一个 `createQmuseAppwriteRuntime()` 实例。
-- React 应用使用 Appwrite Web SDK 客户端；Taro 应用使用 `createPortableAppwriteClients()`。
+- React 应用向 `createQmuseAppwriteRuntime()` 传入 Appwrite Web SDK 客户端；Taro 应用传入跨端 `fetch`、`storage` 和构建期 `appwriteConfig`。
 - H5、支付宝小程序和微信小程序必须使用相同的 `appId`、`env` 和 `domain` 配置来源。
 - React 应用的 `getQmuseLoginUserId()` 只返回有效的用户 ID 或 `null`；Taro 应用固定返回 `null`。
 - 业务代码通过 Runtime 的 CRUD 方法读写数据，不直接拼接 Appwrite HTTP 接口。

package/dist/index.d.ts

@@ -1,3 +1,2 @@
 export { createQmuseAppwriteRuntime } from './runtime';
-export { createPortableAppwriteClients } from './portable';
-export type { AppwriteAccountLike, AppwriteClientLike, AppwriteError, AppwriteRuntimeConfig, AppwriteRuntimeStorage, AppwriteSession, AppwriteTablesDBLike, AppwriteUser, BusinessRowData, CreateRowInput, DeleteRowInput, GetRowInput, ListRowsInput, Models, QmuseAppwriteClients, QmuseAppwriteRuntimeApi, QmuseAppwriteRuntimeOptions, QmuseEnvironment, QmuseRuntimeContext, PortableAppwriteClientsOptions, UpdateRowInput, } from './types';
+export type { AppwriteAccountLike, AppwriteClientLike, AppwriteError, AppwriteRuntimeConfig, AppwriteRuntimeStorage, AppwriteSession, AppwriteTablesDBLike, AppwriteUser, BusinessRowData, CreateRowInput, DeleteRowInput, GetRowInput, ListRowsInput, Models, QmuseAppwriteClients, QmuseAppwriteRuntimeApi, QmuseAppwriteRuntimeOptions, QmuseEnvironment, QmuseRuntimeContext, UpdateRowInput, } from './types';

package/dist/index.js

@@ -1,2 +1 @@
-export { createQmuseAppwriteRuntime } from "./runtime";
-export { createPortableAppwriteClients } from "./portable";
+export { createQmuseAppwriteRuntime } from "./runtime";

package/dist/portable.d.ts

@@ -1,5 +1,5 @@
 import type { AppwriteAccountLike, AppwriteClientLike, AppwriteTablesDBLike, PortableAppwriteClientsOptions } from './types';
-export declare function createPortableAppwriteClients(options: PortableAppwriteClientsOptions): {
+export declare function createPortableAppwriteClientsInternal(options: PortableAppwriteClientsOptions): {
     client: AppwriteClientLike;
     account: AppwriteAccountLike;
     tablesDB: AppwriteTablesDBLike;

package/dist/portable.js

@@ -369,7 +369,7 @@ var PortableTablesDB = /*#__PURE__*/function () {
   }]);
   return PortableTablesDB;
 }();
-export function createPortableAppwriteClients(options) {
+export function createPortableAppwriteClientsInternal(options) {
   var client = new PortableAppwriteClient(options);
   return {
     client: client,

package/dist/runtime/AppwriteSessionCoordinator.d.ts

@@ -1,4 +1,4 @@
-import type { AppwriteUser, QmuseAppwriteRuntimeOptions } from '../types';
+import type { AppwriteUser, ResolvedQmuseAppwriteRuntimeOptions } from '../types';
 export declare class AppwriteSessionCoordinator {
     private readonly options;
     private readonly request;
@@ -6,7 +6,7 @@ export declare class AppwriteSessionCoordinator {
     private initPromise;
     private sessionSyncPromise;
     private refreshPromise;
-    constructor(options: QmuseAppwriteRuntimeOptions, request: typeof globalThis.fetch);
+    constructor(options: ResolvedQmuseAppwriteRuntimeOptions, request: typeof globalThis.fetch);
     init(): Promise<void>;
     getDatabaseId(): Promise<string>;
     getCurrentUser(): Promise<AppwriteUser>;
@@ -16,6 +16,7 @@ export declare class AppwriteSessionCoordinator {
     private getMuseRuntime;
     private requireRuntimeConfig;
     private clearCurrentSession;
+    private validateRuntimeConfig;
     private loadRuntimeConfig;
     private cacheCurrentSession;
     private tryCacheCurrentSession;

package/dist/runtime/AppwriteSessionCoordinator.js

@@ -1,11 +1,12 @@
-import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import _regeneratorRuntime from "@babel/runtime/helpers/esm/regeneratorRuntime";
 import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
 import _createClass from "@babel/runtime/helpers/esm/createClass";
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
 import { createResponseError, getErrorCode, isRecord, readResponsePayload, resolveRuntimeUrl } from "./utils";
+var DEFAULT_AUTH_TOKEN_ENDPOINT = '/runtime/appwrite/auth/custom-token';
 export var AppwriteSessionCoordinator = /*#__PURE__*/function () {
   function AppwriteSessionCoordinator(options, request) {
     _classCallCheck(this, AppwriteSessionCoordinator);
@@ -199,16 +200,40 @@ export var AppwriteSessionCoordinator = /*#__PURE__*/function () {
       this.state.currentSessionProvider = null;
       this.state.confirmedQmuseUserId = null;
     }
+  }, {
+    key: "validateRuntimeConfig",
+    value: function validateRuntimeConfig(config) {
+      if (!isRecord(config)) {
+        throw new Error('Appwrite runtime config is incomplete');
+      }
+      var normalized = {
+        endpoint: config.endpoint,
+        projectId: config.projectId,
+        databaseId: config.databaseId
+      };
+      if (typeof normalized.endpoint !== 'string' || !normalized.endpoint || typeof normalized.projectId !== 'string' || !normalized.projectId || typeof normalized.databaseId !== 'string' || !normalized.databaseId) {
+        throw new Error('Appwrite runtime config is incomplete');
+      }
+      return normalized;
+    }
   }, {
     key: "loadRuntimeConfig",
     value: function () {
       var _loadRuntimeConfig = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6() {
-        var runtime, response, payload, data, config;
+        var runtime, response, payload, data;
         return _regeneratorRuntime().wrap(function _callee6$(_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
+              if (!this.options.appwriteConfig) {
+                _context6.next = 2;
+                break;
+              }
+              return _context6.abrupt("return", _objectSpread(_objectSpread({}, this.validateRuntimeConfig(this.options.appwriteConfig)), {}, {
+                authTokenEndpoint: DEFAULT_AUTH_TOKEN_ENDPOINT
+              }));
+            case 2:
               runtime = this.getMuseRuntime();
-              _context6.next = 3;
+              _context6.next = 5;
               return this.request(resolveRuntimeUrl('/runtime/appwrite/config', runtime.domain), {
                 method: 'POST',
                 credentials: 'include',
@@ -220,15 +245,15 @@ export var AppwriteSessionCoordinator = /*#__PURE__*/function () {
                   env: runtime.env
                 })
               });
-            case 3:
+            case 5:
               response = _context6.sent;
-              _context6.next = 6;
+              _context6.next = 8;
               return readResponsePayload(response);
-            case 6:
+            case 8:
               payload = _context6.sent;
               data = isRecord(payload === null || payload === void 0 ? void 0 : payload.data) ? payload.data : null;
               if (!(!response.ok || (payload === null || payload === void 0 ? void 0 : payload.success) !== true || !data)) {
-                _context6.next = 10;
+                _context6.next = 12;
                 break;
               }
               throw createResponseError({
@@ -237,21 +262,21 @@ export var AppwriteSessionCoordinator = /*#__PURE__*/function () {
                 fallbackMessage: "Appwrite config request failed: ".concat(response.status),
                 fallbackType: 'appwrite_config_error'
               });
-            case 10:
-              config = {
-                endpoint: data.endpoint,
-                projectId: data.projectId,
-                databaseId: data.databaseId,
-                authTokenEndpoint: data.authTokenEndpoint
-              };
-              if (!(typeof config.endpoint !== 'string' || !config.endpoint || typeof config.projectId !== 'string' || !config.projectId || typeof config.databaseId !== 'string' || !config.databaseId || typeof config.authTokenEndpoint !== 'string' || !config.authTokenEndpoint)) {
-                _context6.next = 13;
+            case 12:
+              if (!(typeof data.authTokenEndpoint !== 'string' || !data.authTokenEndpoint)) {
+                _context6.next = 14;
                 break;
               }
               throw new Error('Appwrite runtime config is incomplete');
-            case 13:
-              return _context6.abrupt("return", config);
             case 14:
+              return _context6.abrupt("return", _objectSpread(_objectSpread({}, this.validateRuntimeConfig({
+                endpoint: data.endpoint,
+                projectId: data.projectId,
+                databaseId: data.databaseId
+              })), {}, {
+                authTokenEndpoint: data.authTokenEndpoint
+              }));
+            case 15:
             case "end":
               return _context6.stop();
           }

package/dist/runtime/QmuseAppwriteRuntime.d.ts

@@ -1,4 +1,4 @@
-import type { QmuseAppwriteRuntimeApi, QmuseAppwriteRuntimeOptions } from '../types';
+import type { QmuseAppwriteRuntimeApi, ResolvedQmuseAppwriteRuntimeOptions } from '../types';
 export declare class QmuseAppwriteRuntime implements QmuseAppwriteRuntimeApi {
     private readonly options;
     readonly init: QmuseAppwriteRuntimeApi['init'];
@@ -12,7 +12,7 @@ export declare class QmuseAppwriteRuntime implements QmuseAppwriteRuntimeApi {
     readonly deleteRow: QmuseAppwriteRuntimeApi['deleteRow'];
     private readonly session;
     private readonly auditReporter;
-    constructor(options: QmuseAppwriteRuntimeOptions);
+    constructor(options: ResolvedQmuseAppwriteRuntimeOptions);
     private getClientsInternal;
     private listRowsInternal;
     private getRowInternal;

package/dist/runtime.js

@@ -1,4 +1,17 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import { QmuseAppwriteRuntime } from "./runtime/QmuseAppwriteRuntime";
+import { createPortableAppwriteClientsInternal } from "./portable";
+function resolveRuntimeOptions(options) {
+  if (options.client && options.account && options.tablesDB) {
+    return options;
+  }
+  var clients = createPortableAppwriteClientsInternal({
+    fetch: options.fetch,
+    storage: options.storage,
+    storageKeyPrefix: options.storageKeyPrefix
+  });
+  return _objectSpread(_objectSpread({}, options), clients);
+}
 export function createQmuseAppwriteRuntime(options) {
-  return new QmuseAppwriteRuntime(options);
+  return new QmuseAppwriteRuntime(resolveRuntimeOptions(options));
 }

package/dist/types.d.ts

@@ -10,7 +10,6 @@ export interface AppwriteRuntimeConfig {
     endpoint: string;
     projectId: string;
     databaseId: string;
-    authTokenEndpoint: string;
 }
 export interface AppwriteUser {
     $id: string;
@@ -80,12 +79,29 @@ export interface AppwriteTablesDBLike {
         rowId: string;
     }): Promise<unknown>;
 }
-export interface QmuseAppwriteRuntimeOptions {
+interface QmuseAppwriteRuntimeBaseOptions {
+    getMuseRuntime(): QmuseRuntimeContext;
+    getQmuseLoginUserId(): string | null;
+    appwriteConfig?: AppwriteRuntimeConfig;
+}
+interface QmuseAppwriteInjectedClientsOptions extends QmuseAppwriteRuntimeBaseOptions {
+    client: AppwriteClientLike;
+    account: AppwriteAccountLike;
+    tablesDB: AppwriteTablesDBLike;
+    fetch?: typeof globalThis.fetch;
+    storage?: never;
+}
+interface QmuseAppwritePortableRuntimeOptions extends QmuseAppwriteRuntimeBaseOptions, PortableAppwriteClientsOptions {
+    appwriteConfig: AppwriteRuntimeConfig;
+    client?: never;
+    account?: never;
+    tablesDB?: never;
+}
+export type QmuseAppwriteRuntimeOptions = QmuseAppwriteInjectedClientsOptions | QmuseAppwritePortableRuntimeOptions;
+export interface ResolvedQmuseAppwriteRuntimeOptions extends QmuseAppwriteRuntimeBaseOptions {
     client: AppwriteClientLike;
     account: AppwriteAccountLike;
     tablesDB: AppwriteTablesDBLike;
-    getMuseRuntime(): QmuseRuntimeContext;
-    getQmuseLoginUserId(): string | null;
     fetch?: typeof globalThis.fetch;
 }
 export interface QmuseAppwriteClients {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qmuse/appwrite-runtime-sdk",
-  "version": "1.0.5-dev.1",
+  "version": "1.0.5-dev.3",
   "description": "QMuse Appwrite browser runtime SDK",
   "repository": {
     "type": "git",