@typexim/aics-embed-sdk 0.0.4-alpha.3

package/README.md

@@ -0,0 +1,42 @@
+# TypeX Embed SDK
+
+## 调用方式
+
+```javascript
+import {
+  initialize,
+  isLogin,
+  subscribe,
+  sendMessage,
+} from '@typexim/embed-sdk';
+
+initialize();
+isLogin();
+
+const unsubscribe = subscribe(SubscribeType.feed, (args) => {
+  console.log('feed改变', args);
+});
+unsubscribe();
+sendMessage({
+  type: 'text',
+  content: '你好22',
+});
+```
+
+## API清单
+
+### 初始化
+
+1、initialize注意：所有的端内使用方法都必须在initialize之后调用
+
+### 登录状态判断
+
+isLogin 1、返回值：boolean 2、说明：判断当前用户是否登录
+
+### 订阅
+
+subscribe 1、参数：1.1 type：SubscribeType 1.2 callback：(args: any) => void 2、返回值：unsubscribe：() => void 3、说明：订阅端内事件，事件触发时会调用callback 4、注意：4.2 订阅时需要传入事件类型和回调函数，事件类型可以参考SubscribeType枚举4.3 订阅返回一个unsubscribe函数，调用该函数可以取消订阅
+
+### 发送消息
+
+sendMessage 1、参数：1.1 message：Message 2、返回值：void 3、说明：发送一条消息到端内4、注意：4.1 发送消息前需要先调用initialize方法初始化4.2 消息类型可以参考Message枚举

package/dist/index.es.js

@@ -0,0 +1 @@
+import*as n from"comlink";let t=null;const r=async()=>{try{return t=n.wrap(n.windowEndpoint(window.parent)),!0}catch(n){return console.error("❌ iframe: 连接失败",n),!1}},e=()=>t,o=(t,r)=>{const o=e();if(!o)return()=>{};const i=n.proxy(n=>{r(n)}),s=`${Date.now().toString(36)}-${Math.random().toString(36).substring(2,8)}`;return o.subscribe(t,i,s),()=>{((n,t)=>{const r=e();r&&r.unsubscribe(n,t)})(t,s)}},i=async()=>{const n=e();if(!n)return!1;return await n.isLogin()},s=async n=>{const t=e();if(!t)return!1;return await t.sendMessage(n)};var a,c;!function(n){n.text="text"}(a||(a={})),function(n){n.feed="feed",n.login="login"}(c||(c={}));export{a as MessageType,c as SubscribeType,r as initialize,i as isLogin,s as sendMessage,o as subscribe};

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";function e(e){var r=Object.create(null);return e&&Object.keys(e).forEach(function(t){if("default"!==t){var n=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,n.get?n:{enumerable:!0,get:function(){return e[t]}})}}),r.default=e,Object.freeze(r)}var r=e(require("comlink"));let t=null;const n=()=>t;var s;exports.MessageType=void 0,(exports.MessageType||(exports.MessageType={})).text="text",exports.SubscribeType=void 0,(s=exports.SubscribeType||(exports.SubscribeType={})).feed="feed",s.login="login",exports.initialize=async()=>{try{return t=r.wrap(r.windowEndpoint(window.parent)),!0}catch(e){return console.error("❌ iframe: 连接失败",e),!1}},exports.isLogin=async()=>{const e=n();if(!e)return!1;return await e.isLogin()},exports.sendMessage=async e=>{const r=n();if(!r)return!1;return await r.sendMessage(e)},exports.subscribe=(e,t)=>{const s=n();if(!s)return()=>{};const o=r.proxy(e=>{t(e)}),i=`${Date.now().toString(36)}-${Math.random().toString(36).substring(2,8)}`;return s.subscribe(e,o,i),()=>{((e,r)=>{const t=n();t&&t.unsubscribe(e,r)})(e,i)}};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export { initialize, subscribe } from './init';
+export * from './login';
+export * from './message';
+export * from './types';

package/dist/types/init/index.d.ts

@@ -0,0 +1,17 @@
+import * as comlink from 'comlink';
+import { SubscribeType } from '../types';
+/***
+ * 初始化连接
+ */
+export declare const initialize: () => Promise<boolean>;
+/***
+ * 获取连接对象
+ */
+export declare const getApi: () => comlink.Remote<any> | null;
+/**
+ * 订阅事件
+ * @param type
+ * @param callback
+ * @returns
+ */
+export declare const subscribe: (type: SubscribeType, callback: (args?: any) => void) => () => void;

package/dist/types/login/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 判断是否在登录态
+ * @returns
+ */
+export declare const isLogin: () => Promise<boolean>;

package/dist/types/message/index.d.ts

@@ -0,0 +1,10 @@
+import { MessageType } from '../types';
+/**
+ * 发送消息
+ * @param params
+ * @returns
+ */
+export declare const sendMessage: (params: {
+    type: keyof typeof MessageType;
+    content: string;
+}) => Promise<boolean>;

package/dist/types/types/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 发送消息类型
+ */
+export declare enum MessageType {
+    text = "text"
+}
+/**
+ * 订阅类型
+ */
+export declare enum SubscribeType {
+    feed = "feed",
+    login = "login"
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@typexim/aics-embed-sdk",
+  "version": "0.0.4-alpha.3",
+  "private": false,
+  "license": "UNLICENSED",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/index.es.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "main": "./dist/index.es.js",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "cross-env MODE=prod rollup -c",
+    "dev": "cross-env MODE=dev rollup -c -w",
+    "publish": "yarn run build && npm publish"
+  },
+  "dependencies": {
+    "comlink": "4.4.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-typescript": "12.1.4",
+    "@types/crypto-js": "4.2.2",
+    "@types/js-cookie": "3.0.6",
+    "cross-env": "10.0.0",
+    "rollup": "4.50.1",
+    "rollup-plugin-delete": "3.0.1"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,39 @@
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+import typescript from '@rollup/plugin-typescript';
+import { defineConfig } from 'rollup';
+import del from 'rollup-plugin-delete';
+
+const IS_BUILD = process.env.MODE === 'prod';
+const IS_DEV = process.env.MODE === 'dev';
+
+export default defineConfig({
+  input: 'src/index.ts',
+  output: [
+    {
+      format: 'es',
+      file: 'dist/index.es.js',
+      sourcemap: IS_DEV,
+    },
+    IS_BUILD && {
+      format: 'cjs',
+      file: 'dist/index.js',
+      sourcemap: IS_DEV,
+    },
+  ],
+  plugins: [
+    del({
+      targets: 'dist',
+      runOnce: true,
+    }),
+    typescript({
+      tsconfig: './tsconfig.json',
+      declarationDir: './dist/types',
+      sourceMap: IS_DEV,
+      declarationMap: IS_DEV,
+    }),
+    nodeResolve(),
+    IS_BUILD && terser(),
+  ].filter(Boolean),
+  external: [/node_modules/],
+});

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "lib": ["ESNext", "DOM"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "declaration": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"]
+}