{"_id":"@byted-apaas/embed-sdk","_rev":"9-d93418e6d1368fb38a37074ba4089ad7","name":"@byted-apaas/embed-sdk","dist-tags":{"latest":"1.19.0"},"versions":{"1.15.0":{"name":"@byted-apaas/embed-sdk","version":"1.15.0","author":{"name":"sundichao@bytedance.com"},"license":"MIT","_id":"@byted-apaas/embed-sdk@1.15.0","maintainers":[{"name":"bytednpm","email":"bnpm@bytedance.com"},{"name":"miserylee","email":"miserylee@foxmail.com"},{"name":"zhouwexin","email":"zhouwexin@bytedance.com"},{"name":"mcdyzg","email":"940608110@qq.com"},{"name":"wengeezhang","email":"wengeezhang@gmail.com"},{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},{"name":"qingniaotonghua","email":"1021281778@qq.com"}],"dist":{"shasum":"52212b7715e1878b1d3cf36631fca1fd3466db5a","tarball":"https://registry.npmjs.org/@byted-apaas/embed-sdk/-/embed-sdk-1.15.0.tgz","fileCount":21,"integrity":"sha512-eeMagsSnDeKqtZyxWwmWNic89+0D+/Ql7pGLCKk3l9Y7GT7VGzdsNOVNhjcMe76bb+5oHZ+ncqY3rZIwkkdOHg==","signatures":[{"sig":"MEYCIQDkq63Bauap+ksspQy3olLopIU8AzXCr8FeAGLU8gzjVgIhALzoD15IOTg+175foOQakW4JFy+d8Wbf6XGzj58Qw9m2","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22264},"main":"lib/index.js","_from":"file:embed-sdk-1.15.0.tgz","scripts":{"lint":"eslint . --cache --quiet","test":"jest","build":"dts-build","test:cov":"jest --coverage --silent","check:type":"rush check-type"},"typings":"lib/index.d.ts","_npmUser":{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},"_resolved":"/opt/tiger/compile_path/src/code.byted.org/apaas/builder/output/embed-sdk-1.15.0.tgz","_integrity":"sha512-eeMagsSnDeKqtZyxWwmWNic89+0D+/Ql7pGLCKk3l9Y7GT7VGzdsNOVNhjcMe76bb+5oHZ+ncqY3rZIwkkdOHg==","_npmVersion":"8.19.4","description":"Builder 3.0 被三方嵌入sdk","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^26.6.3","react":"^18.2.0","eslint":"^8.57.0","typescript":"~5.4.2","@types/jest":"~29.2.4","@types/node":"^16","@types/react":"^18.2.0","@apaas-infra/config":"1.0.0","@apaas-infra/dts-build":"0.0.0"},"peerDependencies":{"react":"^17 || ^18"},"_npmOperationalInternal":{"tmp":"tmp/embed-sdk_1.15.0_1744005518936_0.33268313813062655","host":"s3://npm-registry-packages-npm-production"}},"1.16.0":{"name":"@byted-apaas/embed-sdk","version":"1.16.0","author":{"name":"sundichao@bytedance.com"},"license":"MIT","_id":"@byted-apaas/embed-sdk@1.16.0","maintainers":[{"name":"bytednpm","email":"bnpm@bytedance.com"},{"name":"miserylee","email":"miserylee@foxmail.com"},{"name":"zhouwexin","email":"zhouwexin@bytedance.com"},{"name":"mcdyzg","email":"940608110@qq.com"},{"name":"wengeezhang","email":"wengeezhang@gmail.com"},{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},{"name":"qingniaotonghua","email":"1021281778@qq.com"},{"name":"yuki-bytedance","email":"yuqianhuang@bytedance.com"},{"name":"chengshihao1","email":"chengshihao@bytedance.com"}],"dist":{"shasum":"7e7bd0691d4e1c2eae22a8eb26df79244bfa1895","tarball":"https://registry.npmjs.org/@byted-apaas/embed-sdk/-/embed-sdk-1.16.0.tgz","fileCount":21,"integrity":"sha512-Z9JMQOGCEaB0fCiURDlYlOfAp/gqFN1NEjJqfG9F4vUrAs0qQNfHTnJdZjPUphWC0uzu1yu4x+8bT5Nmqi76jA==","signatures":[{"sig":"MEUCIH5ebS+m9yLb7UxoDPT9qKHA0WbQXxwj9yFQBi1qMZn0AiEAjpONcDpDU+ib3C4gE4QS86G+TYZFIHXtLG1mdxag8wA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23961},"main":"lib/index.js","_from":"file:embed-sdk-1.16.0.tgz","scripts":{"lint":"eslint . --cache --quiet","test":"jest","build":"dts-build","test:cov":"jest --coverage --silent","check:type":"rush check-type"},"typings":"lib/index.d.ts","_npmUser":{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},"_resolved":"/opt/tiger/compile_path/src/code.byted.org/apaas/builder/output/embed-sdk-1.16.0.tgz","_integrity":"sha512-Z9JMQOGCEaB0fCiURDlYlOfAp/gqFN1NEjJqfG9F4vUrAs0qQNfHTnJdZjPUphWC0uzu1yu4x+8bT5Nmqi76jA==","_npmVersion":"8.19.4","description":"Builder 3.0 被三方嵌入sdk","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^26.6.3","react":"^18.2.0","eslint":"^8.57.0","typescript":"~5.4.2","@types/jest":"~29.2.4","@types/node":"^16","@types/react":"^18.2.0","@apaas-infra/config":"1.0.0","@apaas-infra/dts-build":"0.0.0"},"peerDependencies":{"react":"^17 || ^18"},"_npmOperationalInternal":{"tmp":"tmp/embed-sdk_1.16.0_1748499988782_0.21870955089390742","host":"s3://npm-registry-packages-npm-production"}},"1.17.0":{"name":"@byted-apaas/embed-sdk","version":"1.17.0","author":{"name":"sundichao@bytedance.com"},"license":"MIT","_id":"@byted-apaas/embed-sdk@1.17.0","maintainers":[{"name":"bytednpm","email":"bnpm@bytedance.com"},{"name":"miserylee","email":"miserylee@foxmail.com"},{"name":"zhouwexin","email":"zhouwexin@bytedance.com"},{"name":"mcdyzg","email":"940608110@qq.com"},{"name":"wengeezhang","email":"wengeezhang@gmail.com"},{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},{"name":"qingniaotonghua","email":"1021281778@qq.com"},{"name":"yuki-bytedance","email":"yuqianhuang@bytedance.com"},{"name":"chengshihao1","email":"chengshihao@bytedance.com"}],"dist":{"shasum":"059c4e62e3bd252a389e802ea1238cdff6996e85","tarball":"https://registry.npmjs.org/@byted-apaas/embed-sdk/-/embed-sdk-1.17.0.tgz","fileCount":23,"integrity":"sha512-tVIjMILCOqOXhzLlfYicaYap5AIMA+nYt5Mih3QBlOuHZZOZzCH8KVeiFjVgkr62D9BHVwAISAdf5WShLdSoYw==","signatures":[{"sig":"MEQCICgS8/QD0EV3lGcJ7W5lGU2IQxPF+kXlUGdVNzXk0knbAiAWuUAJtdpGU9S2QHtlrskKYkcoEGaNQM30ISr0ds8l0g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":24866},"main":"lib/index.js","_from":"file:embed-sdk-1.17.0.tgz","scripts":{"lint":"eslint . --cache --quiet","test":"jest","build":"dts-build","test:cov":"jest --coverage --silent","check:type":"rush check-type"},"typings":"lib/index.d.ts","_npmUser":{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},"_resolved":"/opt/tiger/compile_path/src/code.byted.org/apaas/builder/output/embed-sdk-1.17.0.tgz","_integrity":"sha512-tVIjMILCOqOXhzLlfYicaYap5AIMA+nYt5Mih3QBlOuHZZOZzCH8KVeiFjVgkr62D9BHVwAISAdf5WShLdSoYw==","_npmVersion":"8.19.4","description":"Builder 3.0 被三方嵌入sdk","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^26.6.3","react":"^18.2.0","eslint":"^8.57.0","typescript":"~5.4.2","@types/jest":"~29.2.4","@types/node":"^16","@types/react":"^18.2.0","@apaas-infra/config":"1.0.0","@apaas-infra/dts-build":"0.0.0"},"peerDependencies":{"react":"^17 || ^18"},"_npmOperationalInternal":{"tmp":"tmp/embed-sdk_1.17.0_1749732335788_0.8418911987052298","host":"s3://npm-registry-packages-npm-production"}},"1.18.0":{"name":"@byted-apaas/embed-sdk","version":"1.18.0","author":{"name":"sundichao@bytedance.com"},"license":"MIT","_id":"@byted-apaas/embed-sdk@1.18.0","maintainers":[{"name":"bytednpm","email":"bnpm@bytedance.com"},{"name":"miserylee","email":"miserylee@foxmail.com"},{"name":"zhouwexin","email":"zhouwexin@bytedance.com"},{"name":"mcdyzg","email":"940608110@qq.com"},{"name":"wengeezhang","email":"wengeezhang@gmail.com"},{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},{"name":"qingniaotonghua","email":"1021281778@qq.com"},{"name":"yuki-bytedance","email":"yuqianhuang@bytedance.com"},{"name":"chengshihao1","email":"chengshihao@bytedance.com"},{"name":"heyan.yanis","email":"heyan.yanis@bytedance.com"}],"dist":{"shasum":"4d93b442c6cfc6a8df75ebf38193273f72633638","tarball":"https://registry.npmjs.org/@byted-apaas/embed-sdk/-/embed-sdk-1.18.0.tgz","fileCount":23,"integrity":"sha512-buX0JfyjsdVEnE+3v8nj557teq5WOAXNEwh3XRYWyUDb3dwKSZQ3dnbcjrlXPf7Bd0kwfQkzG7YSA8azDcOXTg==","signatures":[{"sig":"MEUCIQDpQWofzJsO4os3K34zAqK85b9R1ZfgjHX2UfqNsVq/OwIgc6Gd8c8yReBsErAUT9U3KijQO3rcxzrwHpHsNekN8L8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":26482},"main":"lib/index.js","_from":"file:embed-sdk-1.18.0.tgz","scripts":{"lint":"eslint . --cache --pass-on-unpruned-suppressions","test":"jest","build":"dts-build","test:cov":"jest --coverage --silent","check:type":"rush check-type"},"typings":"lib/index.d.ts","_npmUser":{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},"_resolved":"/opt/tiger/compile_path/src/code.byted.org/apaas/builder/output/embed-sdk-1.18.0.tgz","_integrity":"sha512-buX0JfyjsdVEnE+3v8nj557teq5WOAXNEwh3XRYWyUDb3dwKSZQ3dnbcjrlXPf7Bd0kwfQkzG7YSA8azDcOXTg==","_npmVersion":"8.19.4","description":"Builder 3.0 被三方嵌入sdk","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^26.6.3","react":"^18.2.0","eslint":"^9.30.1","typescript":"^5.8.3","@types/jest":"~29.2.4","@types/node":"^18","@types/react":"^18.2.0","@apaas-infra/config":"1.0.0","@apaas-infra/dts-build":"0.0.0"},"peerDependencies":{"react":"^17 || ^18"},"_npmOperationalInternal":{"tmp":"tmp/embed-sdk_1.18.0_1753961066422_0.03676314442805695","host":"s3://npm-registry-packages-npm-production"}},"1.19.0":{"name":"@byted-apaas/embed-sdk","version":"1.19.0","author":{"name":"sundichao@bytedance.com"},"license":"MIT","_id":"@byted-apaas/embed-sdk@1.19.0","maintainers":[{"name":"bytednpm","email":"bnpm@bytedance.com"},{"name":"miserylee","email":"miserylee@foxmail.com"},{"name":"zhouwexin","email":"zhouwexin@bytedance.com"},{"name":"mcdyzg","email":"940608110@qq.com"},{"name":"wengeezhang","email":"wengeezhang@gmail.com"},{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},{"name":"qingniaotonghua","email":"1021281778@qq.com"},{"name":"yuki-bytedance","email":"yuqianhuang@bytedance.com"},{"name":"chengshihao1","email":"chengshihao@bytedance.com"},{"name":"heyan.yanis","email":"heyan.yanis@bytedance.com"}],"dist":{"shasum":"2ce548862239962d393cbf4029fa7a5f94f11ab8","tarball":"https://registry.npmjs.org/@byted-apaas/embed-sdk/-/embed-sdk-1.19.0.tgz","fileCount":23,"integrity":"sha512-ahmvh2xIhipAXZfAMJ53igFIyfXvw6KBFxTuLSjggH8FFnLaQPSam/Ze5q7zobEazep59JCACuHJdGVtMUr+wA==","signatures":[{"sig":"MEUCIQDGA0DweB3aAGBfSIs0gCvSAP1RknXJsdq/XaUTmVbPGgIgAVU1aS0MPQq1qiYHExBYtpIvSUz0WljbSOrEUi54k98=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":26482},"main":"lib/index.js","_from":"file:embed-sdk-1.19.0.tgz","scripts":{"lint":"eslint . --cache --pass-on-unpruned-suppressions","test":"jest","build":"dts-build","test:cov":"jest --coverage --silent","check:type":"rush check-type"},"typings":"lib/index.d.ts","_npmUser":{"name":"weiyu.chen","email":"chenweiyu6909@gmail.com"},"_resolved":"/opt/tiger/compile_path/src/code.byted.org/apaas/builder/output/embed-sdk-1.19.0.tgz","_integrity":"sha512-ahmvh2xIhipAXZfAMJ53igFIyfXvw6KBFxTuLSjggH8FFnLaQPSam/Ze5q7zobEazep59JCACuHJdGVtMUr+wA==","_npmVersion":"8.19.4","description":"Builder 3.0 被三方嵌入sdk","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^26.6.3","react":"^18.2.0","eslint":"^9.30.1","typescript":"^5.8.3","@types/jest":"~29.2.4","@types/node":"^18","@types/react":"^18.2.0","@apaas-infra/config":"1.0.0","@apaas-infra/dts-build":"0.0.0"},"peerDependencies":{"react":"^17 || ^18"},"_npmOperationalInternal":{"tmp":"tmp/embed-sdk_1.19.0_1760072958372_0.5750225332902641","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-04-07T05:58:38.860Z","modified":"2026-02-27T12:38:52.495Z","1.15.0":"2025-04-07T05:58:39.122Z","1.16.0":"2025-05-29T06:26:29.012Z","1.17.0":"2025-06-12T12:45:35.951Z","1.18.0":"2025-07-31T11:24:26.628Z","1.19.0":"2025-10-10T05:09:18.551Z"},"author":{"name":"sundichao@bytedance.com"},"license":"MIT","description":"Builder 3.0 被三方嵌入sdk","maintainers":[{"email":"bnpm@bytedance.com","name":"bytednpm"},{"email":"miserylee@foxmail.com","name":"miserylee"},{"email":"suntianli@bytedance.com","name":"suntianli"},{"email":"zhouwexin@bytedance.com","name":"zhouwexin"},{"email":"940608110@qq.com","name":"mcdyzg"},{"email":"wengeezhang@gmail.com","name":"wengeezhang"},{"email":"chenweiyu6909@gmail.com","name":"weiyu.chen"},{"email":"1021281778@qq.com","name":"qingniaotonghua"},{"email":"yuqianhuang@bytedance.com","name":"yuki-bytedance"},{"email":"chengshihao@bytedance.com","name":"chengshihao1"},{"email":"heyan.yanis@bytedance.com","name":"heyan.yanis"}],"readme":"## 简介\n\n飞书低代码平台提供的用于第三方页面嵌入飞书低代码平台发布页面的SDK（@byted-apaas/embed-sdk）。\n\n## 开始\n\n使用 npm 安装\n\n```shell\nnpm i @byted-apaas/embed-sdk@latest\n```\n\n或使用 yarn 安装\n\n```shell\nyarn add @byted-apaas/embed-sdk@latest\n```\n\n## 使用\n\n```tsx\nimport { getApaasEmbedClient, PersistLevel, logout } from '@byted-apaas/embed-sdk'\n\n// 针对一个域名（租户）获取一个嵌入客户端\n// 相同 baseUrl 始终返回首次创建的实例，仅首次创建的实例会消费其余参数\nconst client = getApaasEmbedClient({\n    baseUrl: 'https://tenantID.feishuapp.cn' // 租户域名，此为示例\n    persistAuthToken: PersistLevel.None // token 持久化选项，默认为 PersistLevel.LocalStorage\n})\n\n// 如果用户的应用是由 React 编写，则可以直接使用 React 组件方式调用\nfunction ApaasEmbedView() {\n    return <client.Component path=\"/ae/apps/v3/namespace/pc/pageID\" />\n}\n\n// 如果用户的应用由其他框架编写，则可以使用 js api 方式调用\nfunction createApaasEmbed(container) {\n    // container 为要插入的目标 dom 容器\n    const component = client.create('/ae/apps/v3/namespace/pc/pageID', container)\n\n    // 如果要更换页面路径，可以调用这个方法\n    component.updatePath('/ae/apps/v3/namespace/pc/anotherPageID')\n\n    // 不再使用时记得销毁实例\n    return () => {\n        component.dispose()\n    }\n}\n\n// 登出当前租户（对同一个 baseUrl 的所有页面都生效）\nclient.logout()\n// 登出所有租户\nlogout()\n```\n\n### `PersistLevel` 的说明如下（保存的时间越长，可能的风险就越高，但同时体验会更无缝）\n\n```ts\nenum PersistLevel {\n  /**\n   * 不持久化\n   */\n  None,\n  /**\n   * 持久化存入 sessionStorage，按浏览器标签页隔离，标签页关闭即自动销毁\n   */\n  SessionStorage,\n  /**\n   * 持久化存入 localStorage，跨标签页共享，始终存在\n   */\n  LocalStorage,\n}\n```\n\n## 注意事项\n\n1. 为了让体验更流程，我们默认会按照 token 持久化存入 localStorage 来生效，但我们推荐 sessionStorage > localStorage > none；如果客户对系统安全性要求较高，或者客户系统会话失效时间很短，建议不要使用 localStorage 方案\n2. 若用户设置了 `persistAuthToken` （持久化 token），需要在自己 IDP 登出的时候同步调用 SDK 中的 `logout` 方法，否则会导致登录态混乱\n3. 用户不能跳过 SDK 手动操作 iframe 的刷新、跳转，否则会丢失登录态\n4. 飞书低代码平台页面在开发时遇到页面跳转需求，需要使用内置的方法，否则会丢失登录态。\n\n- 事件动作：“打开应用页面”\n- SDK: `sdk.page.navigation.openPage(targetPage, { target: '_self' })`\n\n5. 飞书低代码平台页面（被嵌入的子页面）登出仅会登出当前租户\n","readmeFilename":"README.md"}