@xezzon/zeroweb-sdk 0.8.5-beta.0

package/dist/typings/open/index.d.ts

@@ -0,0 +1,28 @@
+import { InstanceConfig } from "../types";
+declare const _default: (config: InstanceConfig) => {
+    /**
+     * 拦截器方法
+     */
+    interceptors: {
+        request: import("axios").AxiosInterceptorManager<import("axios").InternalAxiosRequestConfig>;
+        response: import("axios").AxiosInterceptorManager<import("axios").AxiosResponse>;
+    };
+    /**
+     * 对外接口相关接口
+     */
+    openapi: import("./openapi").OpenapiAPI;
+    /**
+     * 第三方应用订阅相关接口
+     */
+    subscription: import("./subscription").SubscriptionAPI;
+    /**
+     * 第三方应用相关接口
+     */
+    thirdPartyApp: import("./third_party_app").ThirdPartyAppAPI;
+};
+export default _default;
+export { OpenapiStatus } from './openapi';
+export { SubscriptionStatus } from './subscription';
+export type * from './openapi';
+export type * from './subscription';
+export type * from './third_party_app';

package/dist/typings/open/openapi.d.ts

@@ -0,0 +1,67 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+/**
+ * 对外接口状态
+ */
+export declare enum OpenapiStatus {
+    /**
+     * 草稿
+     */
+    DRAFT = 0,
+    /**
+     * 已发布
+     */
+    PUBLISHED = 1
+}
+export interface Openapi {
+    id: string;
+    /**
+     * 接口编码
+     * 即第三方接口调用的路径
+     */
+    code: string;
+    /**
+     * 后端地址
+     * 即该接口转发到的后端接口
+     */
+    destination: string;
+    /**
+     * 接口请求的HTTP方法
+     * 与后端接口的HTTP方法一致
+     */
+    httpMethod: string;
+    /**
+     * 对外接口状态
+     */
+    status: OpenapiStatus;
+}
+/**
+ * 新增开放接口请求
+ */
+declare type AddOpenapiReq = Omit<Openapi, 'id' | 'status'>;
+declare type ModifyOpenapiReq = Omit<Openapi, 'status'>;
+export interface OpenapiAPI {
+    /**
+     * 新增对外接口
+     * @param openapi
+     * @returns
+     */
+    addOpenapi: (Openapi: AddOpenapiReq) => PResponse<Id>;
+    /**
+     * 查询对外接口列表（分页）
+     * @param odata 分页参数
+     * @returns 对外接口列表
+     */
+    getOpenapiList: (odata: OData) => PResponse<Page<Openapi>>;
+    /**
+     * 更新对外接口
+     * @param openapi 对外接口
+     */
+    modifyOpenapi: (openapi: ModifyOpenapiReq) => PResponse<void>;
+    /**
+     * 发布对外接口
+     * @param id 对外接口ID
+     */
+    publishOpenapi: (id: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => OpenapiAPI;
+export default _default;

package/dist/typings/open/subscription.d.ts

@@ -0,0 +1,63 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+import { Openapi } from "./openapi";
+/**
+ * 订阅状态
+ */
+export declare enum SubscriptionStatus {
+    /**
+     * 未订阅
+     */
+    NONE = 0,
+    /**
+     * 审核中
+     */
+    AUDITING = 1,
+    /**
+     * 已订阅
+     */
+    SUBSCRIBED = 2
+}
+/**
+ * 对外接口订阅状态
+ */
+export interface Subscription {
+    id?: string;
+    /**
+     * 第三方应用标识
+     */
+    appId: string;
+    /**
+     * 对外接口编码
+     */
+    openapiCode?: string;
+    /**
+     * 订阅状态
+     */
+    subscriptionStatus: string;
+    /**
+     * 对外接口详情
+     */
+    openapi: Openapi;
+}
+export interface SubscriptionAPI {
+    /**
+     * 订阅对外接口
+     * @param subscription 接口订阅信息
+     */
+    subscribe: (subscription: Subscription) => PResponse<Id>;
+    /**
+     * 查询应用订阅列表
+     * @param appId 应用ID
+     * @param odata 分页查询参数
+     * @returns 订阅列表
+     */
+    listSubscription: (appId: string, odata: OData) => PResponse<Page<Subscription>>;
+    /**
+     * 审核订阅
+     * 审核后第三方应用即可调用该接口
+     * @param id 订阅标识
+     */
+    auditSubscription: (id: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => SubscriptionAPI;
+export default _default;

package/dist/typings/open/third_party_app.d.ts

@@ -0,0 +1,120 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+export declare const BASE_URL = "/third-party-app";
+/**
+ * 第三方应用
+ */
+export interface ThirdPartyApp {
+    id: string;
+    /**
+     * 第三方应用名
+     */
+    name: string;
+    /**
+     * 第三方应用所属人
+     */
+    ownerId: string;
+}
+/**
+ * 第三方应用访问凭据及密钥
+ */
+export interface AccessSecret {
+    id: string;
+    /**
+     * 应用访问凭据
+     */
+    accessKey: string;
+    /**
+     * 应用密钥
+     */
+    secretKey: string;
+}
+/**
+ * 第三方应用成员
+ */
+export interface ThirdPartyAppMember {
+    /**
+     * 第三方应用成员ID
+     */
+    id: string;
+    /**
+     * 第三方应用ID
+     */
+    groupId: string;
+    /**
+     * 用户ID
+     */
+    userId: string;
+    /**
+     * 角色ID
+     */
+    roleId: string;
+    /**
+     * 成员加入第三方应用的时间
+     */
+    createTime: string;
+}
+/**
+ * 新增第三方应用请求
+ */
+declare type AddThirdPartyAppReq = Omit<ThirdPartyApp, 'id' | 'ownerId'>;
+export interface ThirdPartyAppAPI {
+    /**
+     * 新增第三方应用
+     * @param thirdPartyApp 第三方应用
+     */
+    addThirdPartyApp: (thirdPartyApp: AddThirdPartyAppReq) => PResponse<AccessSecret>;
+    /**
+     * 获取当前用户的所有第三方应用列表（分页）
+     * @param odata 分页参数
+     * @returns 第三方应用列表
+     */
+    listMyThirdPartyApp: (odata: OData) => PResponse<Page<ThirdPartyApp>>;
+    /**
+     * 获取所有的第三方应用列表（分页）
+     * @param odata 分页参数
+     * @returns 第三方应用列表
+     */
+    listThirdPartyApp: (odata: OData) => PResponse<Page<ThirdPartyApp>>;
+    /**
+     * 刷新应用访问凭据及密钥
+     * 旧的密钥将失效
+     * @param id 第三方应用ID
+     * @returns 新的应用访问凭据及密钥
+     */
+    rollAccessSecret: (id: string) => PResponse<AccessSecret>;
+    /**
+     * 生成邀请码，持有者可凭借邀请码在有效期内成为第三方应用成员。
+     * @param appId 第三方应用ID
+     * @param timeout 邀请码有效期。单位：小时。默认为 24 小时。
+     * @returns 邀请码
+     */
+    inviteMember: (appId: string, timeout?: number) => PResponse<string>;
+    /**
+     * 邀请用户成为第三方应用成员
+     * @param appId 第三方应用ID
+     * @param userId 用户ID
+     * @param timeout 邀请码有效期。单位：小时。默认为 24 小时。
+     * @returns 邀请码
+     */
+    inviteParticularMember: (appId: string, userId: string, timeout?: number) => PResponse<string>;
+    /**
+     * 持邀请码成为第三方应用成员
+     * @param token 邀请码
+     * @returns 成员ID。注意：该 ID 不是用户的 ID。
+     */
+    addThirdPartyAppMember: (token: string) => PResponse<Id>;
+    /**
+     * 查询第三方应用的成员
+     * @param appId 第三方应用
+     * @returns 第三方应用成员列表
+     */
+    listThirdPartyAppMember: (appId: string) => PResponse<ThirdPartyAppMember[]>;
+    /**
+     * 第三方应用所有权转移
+     * @param appId 第三方应用ID
+     * @param userId 用户ID
+     */
+    moveOwnerShip: (appId: string, userId: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => ThirdPartyAppAPI;
+export default _default;

package/dist/typings/types.d.ts

@@ -0,0 +1,52 @@
+import { AxiosInstance, AxiosResponse, CreateAxiosDefaults } from "axios";
+/**
+ * @see {@link https://docs.oasis-open.org/odata/odata/v4.01/cs01/abnf/odata-abnf-construction-rules.txt | OData ABNF Construction Rules Version 4.01}
+ */
+export interface OData {
+    /**
+     * 分页大小
+     */
+    top: number;
+    /**
+     * 偏移量
+     * (页码 - 1) * 分页大小
+     * 页码从1开始
+     */
+    skip: number;
+}
+/**
+ * 分页
+ */
+export interface Page<T> {
+    /**
+     * 数据列表
+     */
+    content: T[];
+    /**
+     * 分页信息
+     */
+    page: {
+        /**
+         * 分页大小
+         */
+        size: number;
+        /**
+         * 页码
+         */
+        number: number;
+        /**
+         * 总数据量
+         */
+        totalElements: number;
+        /**
+         * 总页数
+         */
+        totalPages: null;
+    };
+}
+export interface Id {
+    id: string;
+}
+export declare type HttpClient = AxiosInstance;
+export declare type InstanceConfig = CreateAxiosDefaults;
+export declare type PResponse<T> = Promise<AxiosResponse<T>>;

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@xezzon/zeroweb-sdk",
+  "version": "0.8.5-beta.0",
+  "types": "dist/typings/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/typings/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "oxlint",
+    "build": "pnpm run build:cjs && pnpm run build:esm",
+    "build:esm": "tsc --module esnext --outDir dist/esm && tsc-alias",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs && tsc-alias"
+  },
+  "devDependencies": {
+    "@types/crypto-js": "^4.2.2",
+    "@types/node": "^25.0.1",
+    "@zeroweb/oxlint": "workspace:^",
+    "oxlint": "catalog:",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "axios": "^1.13.2",
+    "crypto-js": "^4.2.0",
+    "js-crc": "^0.3.1"
+  }
+}