@skillbuilder/endpoints 0.0.0-stage → 0.0.6

package/README.md

@@ -1,3 +1,8 @@
-# Temporary Holding Version
+# @skillbuilder/endpoints
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+集中维护 VectorX monorepo（Node 侧）各类业务域名与 endpoint，避免在各包里散落硬编码 URL。
+
+## 环境变量（兼容现有包）
+
+- `AGENT_BUILD_ENV`: `development` | `sit` | `production`（用于 miniapp 相关域名选择）
+- `OPEN_PLATFORM_STAGE`: `development` | `production`（用于 agentbase 相关域名选择）

package/esm/config/consumers.js

@@ -0,0 +1,5 @@
+export const CONSUMER_BASE_URL_SERVICE = {
+    "@skillbuilder/minitool-core": "miniapp",
+    "@skillbuilder/database-sdk": "miniapp",
+    "@skillbuilder/functions-framework": "agentbase",
+};

package/esm/config/endpoints.js

@@ -0,0 +1,35 @@
+export const MINIAPP_BASE_URL = "https://miniapp.xiaohongshu.com";
+export const MINIAPP_BETA_BASE_URL = "https://miniapp.xiaohongshu.com";
+export const MINIAPP_SIMULATOR_SERVICE_URL = "https://miniapp-sandbox.xiaohongshu.com/simulator/";
+export const EDITH_BASE_URL = "https://edith.xiaohongshu.com";
+export const AGENTBASE_BASE_URL_BY_STAGE = {
+    development: "https://agentbase-sandbox.xiaohongshu.com",
+    production: "https://agentbase.xiaohongshu.com",
+};
+export const APM_DATA_ENDPOINT = "https://apm-fe.xiaohongshu.com/api/data";
+export const MODEL_SERVICE_CONFIG_BY_PROVIDER = {
+    bailian: {
+        name: "百炼 / DashScope（OpenAI-compatible，公网直连）",
+        endpoint: "https://dashscope.aliyuncs.com/compatible-mode/v1",
+        keyEnv: "DASHSCOPE_API_KEY",
+        protocol: "openai-compatible",
+    },
+    "runway-zhipu": {
+        name: "Runway 智谱 GLM 网关（内网；沙箱未放行公网时的兜底服务）",
+        endpoint: "https://runway.devops.xiaohongshu.com/openai/zhipu/paas/v4",
+        keyEnv: "RUNWAY_ZHIPU_API_KEY",
+        protocol: "openai-compatible",
+    },
+    anthropic: {
+        name: "Runway anthropic 网关（内网）",
+        endpoint: "https://runway.devops.rednote.life/openai/google/anthropic",
+        keyEnv: "RUNWAY_API_KEY",
+        protocol: "anthropic",
+    },
+    qs: {
+        name: "QuickSilver MaaS（OpenAI-compatible，内网）",
+        endpoint: "https://maas.devops.xiaohongshu.com/v1",
+        keyEnv: "QS_API_KEY",
+        protocol: "openai-compatible",
+    },
+};

package/esm/index.js

@@ -0,0 +1,50 @@
+import { CONSUMER_BASE_URL_SERVICE } from "./config/consumers";
+import { AGENTBASE_BASE_URL_BY_STAGE, APM_DATA_ENDPOINT, EDITH_BASE_URL as EDITH_BASE_URL_CONFIG, MINIAPP_BASE_URL, MINIAPP_BETA_BASE_URL, MODEL_SERVICE_CONFIG_BY_PROVIDER, } from "./config/endpoints";
+export { MODEL_SERVICE_CONFIG_BY_PROVIDER };
+export { MINIAPP_SIMULATOR_SERVICE_URL } from "./config/endpoints";
+export const EDITH_BASE_URL = EDITH_BASE_URL_CONFIG;
+function trimTrailingSlash(url) {
+    return url.replace(/\/$/, "");
+}
+function resolveAgentbaseStage(env) {
+    const explicit = (env.OPEN_PLATFORM_STAGE || "").trim();
+    if (explicit === "development" || explicit === "production")
+        return explicit;
+    return "development";
+}
+export function getMiniappBaseUrl(env = process.env) {
+    return trimTrailingSlash(MINIAPP_BASE_URL);
+}
+export function getMiniappBetaBaseUrl(env = process.env) {
+    return trimTrailingSlash(MINIAPP_BETA_BASE_URL);
+}
+export function getAgentbaseBaseUrl(env = process.env) {
+    const stage = resolveAgentbaseStage(env);
+    return trimTrailingSlash(AGENTBASE_BASE_URL_BY_STAGE[stage]);
+}
+export function getApmDataEndpoint(env = process.env) {
+    return trimTrailingSlash(APM_DATA_ENDPOINT);
+}
+export function getModelServiceEndpoint(provider) {
+    return trimTrailingSlash(MODEL_SERVICE_CONFIG_BY_PROVIDER[provider].endpoint);
+}
+export function getBaseUrlByService(service, env = process.env) {
+    if (service === "miniapp")
+        return getMiniappBaseUrl(env);
+    if (service === "agentbase")
+        return getAgentbaseBaseUrl(env);
+    throw new Error(`@skillbuilder/endpoints: unknown baseUrl service: ${String(service)}`);
+}
+export function getBaseUrlByConsumer(consumer, env = process.env) {
+    const service = CONSUMER_BASE_URL_SERVICE[consumer];
+    return getBaseUrlByService(service, env);
+}
+export function resolveUrl(consumer, urlKey, env = process.env) {
+    if (urlKey === "baseUrl")
+        return getBaseUrlByConsumer(consumer, env);
+    if (urlKey === "betaBaseUrl")
+        return getMiniappBetaBaseUrl(env);
+    if (urlKey === "apmDataEndpoint")
+        return getApmDataEndpoint(env);
+    throw new Error(`@skillbuilder/endpoints: unknown urlKey: ${String(urlKey)} (consumer=${consumer})`);
+}

package/esm/stages.js

@@ -0,0 +1 @@
+export {};

package/lib/config/consumers.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONSUMER_BASE_URL_SERVICE = void 0;
+exports.CONSUMER_BASE_URL_SERVICE = {
+    "@skillbuilder/minitool-core": "miniapp",
+    "@skillbuilder/database-sdk": "miniapp",
+    "@skillbuilder/functions-framework": "agentbase",
+};

package/lib/config/endpoints.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MODEL_SERVICE_CONFIG_BY_PROVIDER = exports.APM_DATA_ENDPOINT = exports.AGENTBASE_BASE_URL_BY_STAGE = exports.EDITH_BASE_URL = exports.MINIAPP_SIMULATOR_SERVICE_URL = exports.MINIAPP_BETA_BASE_URL = exports.MINIAPP_BASE_URL = void 0;
+exports.MINIAPP_BASE_URL = "https://miniapp.xiaohongshu.com";
+exports.MINIAPP_BETA_BASE_URL = "https://miniapp.xiaohongshu.com";
+exports.MINIAPP_SIMULATOR_SERVICE_URL = "https://miniapp-sandbox.xiaohongshu.com/simulator/";
+exports.EDITH_BASE_URL = "https://edith.xiaohongshu.com";
+exports.AGENTBASE_BASE_URL_BY_STAGE = {
+    development: "https://agentbase-sandbox.xiaohongshu.com",
+    production: "https://agentbase.xiaohongshu.com",
+};
+exports.APM_DATA_ENDPOINT = "https://apm-fe.xiaohongshu.com/api/data";
+exports.MODEL_SERVICE_CONFIG_BY_PROVIDER = {
+    bailian: {
+        name: "百炼 / DashScope（OpenAI-compatible，公网直连）",
+        endpoint: "https://dashscope.aliyuncs.com/compatible-mode/v1",
+        keyEnv: "DASHSCOPE_API_KEY",
+        protocol: "openai-compatible",
+    },
+    "runway-zhipu": {
+        name: "Runway 智谱 GLM 网关（内网；沙箱未放行公网时的兜底服务）",
+        endpoint: "https://runway.devops.xiaohongshu.com/openai/zhipu/paas/v4",
+        keyEnv: "RUNWAY_ZHIPU_API_KEY",
+        protocol: "openai-compatible",
+    },
+    anthropic: {
+        name: "Runway anthropic 网关（内网）",
+        endpoint: "https://runway.devops.rednote.life/openai/google/anthropic",
+        keyEnv: "RUNWAY_API_KEY",
+        protocol: "anthropic",
+    },
+    qs: {
+        name: "QuickSilver MaaS（OpenAI-compatible，内网）",
+        endpoint: "https://maas.devops.xiaohongshu.com/v1",
+        keyEnv: "QS_API_KEY",
+        protocol: "openai-compatible",
+    },
+};

package/lib/index.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EDITH_BASE_URL = exports.MINIAPP_SIMULATOR_SERVICE_URL = exports.MODEL_SERVICE_CONFIG_BY_PROVIDER = void 0;
+exports.getMiniappBaseUrl = getMiniappBaseUrl;
+exports.getMiniappBetaBaseUrl = getMiniappBetaBaseUrl;
+exports.getAgentbaseBaseUrl = getAgentbaseBaseUrl;
+exports.getApmDataEndpoint = getApmDataEndpoint;
+exports.getModelServiceEndpoint = getModelServiceEndpoint;
+exports.getBaseUrlByService = getBaseUrlByService;
+exports.getBaseUrlByConsumer = getBaseUrlByConsumer;
+exports.resolveUrl = resolveUrl;
+const consumers_1 = require("./config/consumers");
+const endpoints_1 = require("./config/endpoints");
+Object.defineProperty(exports, "MODEL_SERVICE_CONFIG_BY_PROVIDER", { enumerable: true, get: function () { return endpoints_1.MODEL_SERVICE_CONFIG_BY_PROVIDER; } });
+var endpoints_2 = require("./config/endpoints");
+Object.defineProperty(exports, "MINIAPP_SIMULATOR_SERVICE_URL", { enumerable: true, get: function () { return endpoints_2.MINIAPP_SIMULATOR_SERVICE_URL; } });
+exports.EDITH_BASE_URL = endpoints_1.EDITH_BASE_URL;
+function trimTrailingSlash(url) {
+    return url.replace(/\/$/, "");
+}
+function resolveAgentbaseStage(env) {
+    const explicit = (env.OPEN_PLATFORM_STAGE || "").trim();
+    if (explicit === "development" || explicit === "production")
+        return explicit;
+    return "development";
+}
+function getMiniappBaseUrl(env = process.env) {
+    return trimTrailingSlash(endpoints_1.MINIAPP_BASE_URL);
+}
+function getMiniappBetaBaseUrl(env = process.env) {
+    return trimTrailingSlash(endpoints_1.MINIAPP_BETA_BASE_URL);
+}
+function getAgentbaseBaseUrl(env = process.env) {
+    const stage = resolveAgentbaseStage(env);
+    return trimTrailingSlash(endpoints_1.AGENTBASE_BASE_URL_BY_STAGE[stage]);
+}
+function getApmDataEndpoint(env = process.env) {
+    return trimTrailingSlash(endpoints_1.APM_DATA_ENDPOINT);
+}
+function getModelServiceEndpoint(provider) {
+    return trimTrailingSlash(endpoints_1.MODEL_SERVICE_CONFIG_BY_PROVIDER[provider].endpoint);
+}
+function getBaseUrlByService(service, env = process.env) {
+    if (service === "miniapp")
+        return getMiniappBaseUrl(env);
+    if (service === "agentbase")
+        return getAgentbaseBaseUrl(env);
+    throw new Error(`@skillbuilder/endpoints: unknown baseUrl service: ${String(service)}`);
+}
+function getBaseUrlByConsumer(consumer, env = process.env) {
+    const service = consumers_1.CONSUMER_BASE_URL_SERVICE[consumer];
+    return getBaseUrlByService(service, env);
+}
+function resolveUrl(consumer, urlKey, env = process.env) {
+    if (urlKey === "baseUrl")
+        return getBaseUrlByConsumer(consumer, env);
+    if (urlKey === "betaBaseUrl")
+        return getMiniappBetaBaseUrl(env);
+    if (urlKey === "apmDataEndpoint")
+        return getApmDataEndpoint(env);
+    throw new Error(`@skillbuilder/endpoints: unknown urlKey: ${String(urlKey)} (consumer=${consumer})`);
+}

package/lib/stages.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "@skillbuilder/endpoints",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.6",
+  "description": "Centralized service endpoints for the VectorX monorepo",
+  "main": "lib/index.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "lib",
+    "esm",
+    "types",
+    "README.md"
+  ],
+  "keywords": [
+    "endpoints",
+    "config",
+    "nodejs",
+    "vectorx"
+  ],
+  "author": "",
+  "license": "ISC",
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}

package/types/config/consumers.d.ts

@@ -0,0 +1,3 @@
+export type VectorxConsumerPackage = "@skillbuilder/minitool-core" | "@skillbuilder/database-sdk" | "@skillbuilder/functions-framework";
+export type VectorxBaseUrlService = "miniapp" | "agentbase";
+export declare const CONSUMER_BASE_URL_SERVICE: Record<VectorxConsumerPackage, VectorxBaseUrlService>;

package/types/config/endpoints.d.ts

@@ -0,0 +1,40 @@
+import type { AgentbaseStage } from "../stages";
+export declare const MINIAPP_BASE_URL = "https://miniapp.xiaohongshu.com";
+export declare const MINIAPP_BETA_BASE_URL = "https://miniapp.xiaohongshu.com";
+export declare const MINIAPP_SIMULATOR_SERVICE_URL = "https://miniapp-sandbox.xiaohongshu.com/simulator/";
+export declare const EDITH_BASE_URL = "https://edith.xiaohongshu.com";
+export declare const AGENTBASE_BASE_URL_BY_STAGE: Record<AgentbaseStage, string>;
+export declare const APM_DATA_ENDPOINT = "https://apm-fe.xiaohongshu.com/api/data";
+export type ModelServiceProtocol = "openai-compatible" | "anthropic";
+export interface ModelServiceConfig {
+    name: string;
+    endpoint: string;
+    keyEnv: string;
+    protocol: ModelServiceProtocol;
+}
+export declare const MODEL_SERVICE_CONFIG_BY_PROVIDER: {
+    readonly bailian: {
+        readonly name: "百炼 / DashScope（OpenAI-compatible，公网直连）";
+        readonly endpoint: "https://dashscope.aliyuncs.com/compatible-mode/v1";
+        readonly keyEnv: "DASHSCOPE_API_KEY";
+        readonly protocol: "openai-compatible";
+    };
+    readonly "runway-zhipu": {
+        readonly name: "Runway 智谱 GLM 网关（内网；沙箱未放行公网时的兜底服务）";
+        readonly endpoint: "https://runway.devops.xiaohongshu.com/openai/zhipu/paas/v4";
+        readonly keyEnv: "RUNWAY_ZHIPU_API_KEY";
+        readonly protocol: "openai-compatible";
+    };
+    readonly anthropic: {
+        readonly name: "Runway anthropic 网关（内网）";
+        readonly endpoint: "https://runway.devops.rednote.life/openai/google/anthropic";
+        readonly keyEnv: "RUNWAY_API_KEY";
+        readonly protocol: "anthropic";
+    };
+    readonly qs: {
+        readonly name: "QuickSilver MaaS（OpenAI-compatible，内网）";
+        readonly endpoint: "https://maas.devops.xiaohongshu.com/v1";
+        readonly keyEnv: "QS_API_KEY";
+        readonly protocol: "openai-compatible";
+    };
+};

package/types/index.d.ts

@@ -0,0 +1,18 @@
+import type { VectorxBaseUrlService, VectorxConsumerPackage } from "./config/consumers";
+import { MODEL_SERVICE_CONFIG_BY_PROVIDER } from "./config/endpoints";
+import type { ModelServiceConfig, ModelServiceProtocol } from "./config/endpoints";
+export type { AgentbaseStage, MiniappStage } from "./stages";
+export type { ModelServiceConfig, ModelServiceProtocol, VectorxBaseUrlService, VectorxConsumerPackage, };
+export type ModelServiceProvider = keyof typeof MODEL_SERVICE_CONFIG_BY_PROVIDER;
+export { MODEL_SERVICE_CONFIG_BY_PROVIDER };
+export { MINIAPP_SIMULATOR_SERVICE_URL } from "./config/endpoints";
+export declare const EDITH_BASE_URL = "https://edith.xiaohongshu.com";
+export type VectorxUrlKey = "baseUrl" | "betaBaseUrl" | "apmDataEndpoint";
+export declare function getMiniappBaseUrl(env?: NodeJS.ProcessEnv): string;
+export declare function getMiniappBetaBaseUrl(env?: NodeJS.ProcessEnv): string;
+export declare function getAgentbaseBaseUrl(env?: NodeJS.ProcessEnv): string;
+export declare function getApmDataEndpoint(env?: NodeJS.ProcessEnv): string;
+export declare function getModelServiceEndpoint(provider: ModelServiceProvider): string;
+export declare function getBaseUrlByService(service: VectorxBaseUrlService, env?: NodeJS.ProcessEnv): string;
+export declare function getBaseUrlByConsumer(consumer: VectorxConsumerPackage, env?: NodeJS.ProcessEnv): string;
+export declare function resolveUrl(consumer: VectorxConsumerPackage, urlKey: VectorxUrlKey, env?: NodeJS.ProcessEnv): string;

package/types/stages.d.ts

@@ -0,0 +1,2 @@
+export type MiniappStage = "development" | "sit" | "production";
+export type AgentbaseStage = "development" | "production";