@logseq/libs - npm Package Compare versions

Comparing version 0.0.1-alpha.0 to 0.0.1-alpha.1

dist/LSPlugin.d.ts

+import EventEmitter from 'eventemitter3'
+import { LSPluginCaller } from './LSPlugin.caller'
+
+type PluginLocalIdentity = string
+
+type ThemeOptions = {
+  name: string
+  url: string
+  description?: string
+  mode?: 'dark' | 'light'
+
+  [key: string]: any
+}
+
+type StyleString = string
+type StyleOptions = {
+  key?: string
+  style: StyleString
+}
+
+type UIBaseOptions = {
+  key?: string
+  replace?: boolean
+  template: string
+}
+
+type UIPathIdentity = {
+  path: string // dom selector
+}
+
+type UISlotIdentity = {
+  slot: string // slot key
+}
+
+type UISlotOptions = UIBaseOptions & UISlotIdentity
+type UIPathOptions = UIBaseOptions & UIPathIdentity
+type UIOptions = UIPathOptions & UISlotOptions
+
+interface LSPluginPkgConfig {
+  id: PluginLocalIdentity
+  mode: 'shadow' | 'iframe'
+  themes: Array<ThemeOptions>
+  icon: string
+}
+
+interface LSPluginBaseInfo {
+  id: string // should be unique
+  mode: 'shadow' | 'iframe'
+
+  settings: {
+    disabled: boolean
+    [key: string]: any
+  },
+
+  [key: string]: any
+}
+
+type IHookEvent = {
+  [key: string]: any
+}
+
+type IUserHook = (callback: (e: IHookEvent) => void) => void
+type IUserSlotHook = (callback: (e: IHookEvent & UISlotIdentity) => void) => void
+
+interface IAppProxy {
+  pushState: (k: string, params?: {}) => void
+  replaceState: (k: string, params?: {}) => void
+  getUserState: () => Promise<any>
+  showMsg: (content: string, status?: 'success' | 'warning' | string) => void
+  setZoomFactor: (factor: number) => void
+  onThemeModeChanged: IUserHook
+  onPageFileMounted: IUserSlotHook
+  onBlockRendererMounted: IUserSlotHook
+}
+
+interface IEditorProxy {
+  getCurrentPageBlocksTree: <T = any> () => Promise<T>
+}
+
+interface IDBProxy {
+  datascriptQuery: <T = any>(query: string) => Promise<T>
+}
+
+interface ILSPluginThemeManager extends EventEmitter {
+  themes: Map<PluginLocalIdentity, Array<ThemeOptions>>
+
+  registerTheme (id: PluginLocalIdentity, opt: ThemeOptions): Promise<void>
+
+  unregisterTheme (id: PluginLocalIdentity): Promise<void>
+
+  selectTheme (opt?: ThemeOptions): Promise<void>
+}
+
+type LSPluginUserEvents = 'ui:visible:changed' | 'settings:changed'
+
+interface ILSPluginUser extends EventEmitter<LSPluginUserEvents> {
+  /**
+   * Indicate connected with host
+   */
+  connected: boolean
+
+  /**
+   * Duplex message caller
+   */
+  caller: LSPluginCaller
+
+  /**
+   * Most from packages
+   */
+  baseInfo: LSPluginBaseInfo
+
+  /**
+   * Plugin user settings
+   */
+  settings?: LSPluginBaseInfo.settings
+
+  /**
+   * Ready for host connected
+   */
+  ready (model?: Record<string, any>): Promise<any>
+
+  ready (callback?: (e: any) => void | {}): Promise<any>
+
+  ready (model?: Record<string, any>, callback?: (e: any) => void | {}): Promise<any>
+
+  /**
+   * @param model
+   */
+  provideModel (model: Record<string, any>): this
+
+  /**
+   * @param theme options
+   */
+  provideTheme (theme: ThemeOptions): this
+
+  /**
+   * @param style
+   */
+  provideStyle (style: StyleString | StyleOptions): this
+
+  /**
+   * @param ui options
+   */
+  provideUI (ui: UIOptions): this
+
+  /**
+   * @param attrs
+   */
+  updateSettings (attrs: Record<string, any>): void
+
+  /**
+   * MainUI for index.html
+   * @param attrs
+   */
+  setMainUIAttrs (attrs: Record<string, any>): void
+
+  setMainUIInlineStyle (style: CSSStyleDeclaration): void
+
+  showMainUI (): void
+
+  hideMainUI (): void
+
+  toggleMainUI (): void
+
+  App: IAppProxy
+  Editor: IEditorProxy
+  DB: IDBProxy
+}

index.d.ts

@@ -1,2 +0,2 @@
-import { ILSPluginUser } from './src/LSPlugin'
+import { ILSPluginUser } from './dist/LSPlugin'
 
@@ -3,0 +3,0 @@ declare global {

package.json

 {
   "name": "@logseq/libs",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "description": "Logseq SDK libraries",
@@ -13,3 +13,3 @@ "main": "dist/lsplugin.user.js",
     "dev:core": "npm run build:core -- --mode development --watch",
-    "build": "tsc && rm dist/*.js && npm run build:user"
+    "build": "tsc && rm dist/*.js && cp src/*.d.ts dist/ && npm run build:user"
   },
@@ -16,0 +16,0 @@ "dependencies": {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42914

8.63%

Number of package files

12

9.09%

Lines of code

507

33.77%

No dependency changes