roamjs-components 0.85.6 → 0.85.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "roamjs-components",
3
3
  "description": "Expansive toolset, utilities, & components for developing RoamJS extensions.",
4
- "version": "0.85.6",
4
+ "version": "0.85.7",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "scripts": {
package/types/index.d.ts CHANGED
@@ -99,7 +99,7 @@ declare global {
99
99
  };
100
100
  };
101
101
  backend: {
102
- q: (query: string, ...params: unknown[]) => unknown[][];
102
+ q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;
103
103
  };
104
104
  page: {
105
105
  create: WriteAction;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAmBA,mDAAyB","sourcesContent":["import {\n AddPullWatch,\n PullBlock,\n SidebarAction,\n SidebarWindow,\n SidebarWindowInput,\n WriteAction,\n} from \"./native\";\nimport {\n RunQuery,\n ListActiveQueries,\n RunQuerySync,\n IsDiscourseNode,\n} from \"./query-builder\";\nimport { RegisterCommand, UnregisterCommand } from \"./smartblocks\";\nimport type marked from \"marked\";\nimport type Markdown from \"marked-react\";\nimport type JSZip from \"jszip\";\nimport type cytoscape from \"cytoscape\";\nexport * from \"./native\";\n\nexport type Registry = {\n elements: HTMLElement[];\n reactRoots: HTMLElement[];\n observers: MutationObserver[];\n domListeners: (\n | {\n el: Window;\n type: keyof WindowEventMap;\n listener: (\n this: Window,\n ev: WindowEventMap[keyof WindowEventMap]\n ) => void;\n }\n | {\n el: Document;\n type: keyof DocumentEventMap;\n listener: (\n this: Document,\n ev: DocumentEventMap[keyof DocumentEventMap]\n ) => void;\n }\n | {\n el: HTMLElement;\n type: keyof HTMLElementEventMap | `roamjs:${string}`;\n listener: (\n this: HTMLElement,\n ev: HTMLElementEventMap[keyof HTMLElementEventMap]\n ) => void;\n }\n )[];\n commands: string[];\n timeouts: { timeout: number }[];\n};\n\ndeclare global {\n interface Window {\n // TODO remove\n RoamLazy?: {\n JSZip: () => Promise<typeof JSZip>;\n Marked: () => Promise<typeof marked>;\n MarkedReact: () => Promise<typeof Markdown>;\n Cytoscape: () => Promise<typeof cytoscape>;\n Insect: () => Promise<{\n // insect uses purescript instead of typescript -.-\n commands: string[];\n fmtConsole: (M: unknown) => unknown;\n fmtJqueryTerminal: (M: unknown) => unknown;\n fmtPlain: (M: unknown) => unknown;\n functions: (M: unknown) => unknown;\n identifiers: (M: unknown) => unknown;\n initialEnvironment: { values: unknown; functions: unknown };\n repl: (\n fmt: (M: unknown) => unknown\n ) => (env: {\n values: unknown;\n functions: unknown;\n }) => (s: string) => { msg: string };\n }>;\n };\n // END TODO remove\n\n roamAlphaAPI: {\n q: (query: string, ...params: unknown[]) => unknown[][];\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => PullBlock;\n createBlock: WriteAction;\n updateBlock: WriteAction;\n createPage: WriteAction;\n moveBlock: WriteAction;\n deleteBlock: WriteAction;\n updatePage: WriteAction;\n deletePage: WriteAction;\n util: {\n generateUID: () => string;\n dateToPageTitle: (date: Date) => string;\n dateToPageUid: (date: Date) => string;\n pageTitleToDate: (title: string) => Date | null;\n uploadFile: (args: { file: File }) => string;\n };\n data: {\n addPullWatch: AddPullWatch;\n block: {\n create: WriteAction;\n update: WriteAction;\n move: WriteAction;\n delete: WriteAction;\n reorderBlocks: (args: {\n location: { \"parent-uid\": string };\n blocks: string[];\n }) => Promise<void>;\n };\n fast: {\n q: (query: string, ...params: unknown[]) => unknown[][];\n };\n async: {\n q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => Promise<PullBlock>;\n pull_many: (\n pattern: string,\n eids: string[][]\n ) => Promise<PullBlock[]>;\n fast: {\n q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;\n };\n };\n backend: {\n q: (query: string, ...params: unknown[]) => unknown[][];\n };\n page: {\n create: WriteAction;\n update: WriteAction;\n delete: WriteAction;\n };\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => PullBlock;\n pull_many: (pattern: string, eids: string[][]) => PullBlock[];\n q: (query: string, ...params: unknown[]) => unknown[][];\n removePullWatch: (\n pullPattern: string,\n entityId: string,\n callback?: (before: PullBlock, after: PullBlock) => void\n ) => boolean;\n redo: () => void;\n undo: () => void;\n user: {\n upsert: () => void;\n };\n };\n ui: {\n leftSidebar: {\n open: () => Promise<void>;\n close: () => Promise<void>;\n };\n rightSidebar: {\n open: () => Promise<void>;\n close: () => Promise<void>;\n getWindows: () => SidebarWindow[];\n addWindow: SidebarAction;\n setWindowOrder: SidebarAction;\n collapseWindow: SidebarAction;\n pinWindow: (action: {\n window: SidebarWindowInput;\n \"pin-to-top?\"?: boolean;\n }) => Promise<void>;\n expandWindow: SidebarAction;\n removeWindow: SidebarAction;\n unpinWindow: SidebarAction;\n };\n commandPalette: {\n addCommand: (action: {\n label: string;\n callback: () => void;\n \"disable-hotkey\"?: boolean;\n \"default-hotkey\"?: string | string[];\n }) => Promise<void>;\n removeCommand: (action: { label: string }) => Promise<void>;\n };\n blockContextMenu: {\n addCommand: (action: {\n label: string;\n callback: (props: {\n \"block-string\": string;\n \"block-uid\": string;\n heading: 0 | 1 | 2 | 3 | null;\n \"page-uid\": string;\n \"read-only?\": boolean;\n \"window-id\": string;\n }) => void;\n }) => void;\n removeCommand: (action: { label: string }) => void;\n };\n individualMultiselect: {\n getSelectedUids: () => string[];\n };\n msContextMenu: {\n addCommand: (action: {\n label: string;\n callback: () => void;\n \"display-conditional\"?: () => boolean;\n }) => void;\n removeCommand: (action: { label: string }) => void;\n };\n filters: {\n addGlobalFilter: (args: {\n title: string;\n type: \"includes\" | \"removes\";\n }) => Promise<void>;\n removeGlobalFilter: (args: {\n title: string;\n type: \"includes\" | \"removes\";\n }) => Promise<void>;\n getGlobalFilters: () => { includes: string[]; removes: string[] };\n getPageFilters: (args: {\n page: { uid?: string; title?: string };\n }) => {\n includes: string[];\n removes: string[];\n };\n getPageLinkedRefsFilters: (args: {\n page: { uid?: string; title?: string };\n }) => {\n includes: string[];\n removes: string[];\n };\n getSidebarWindowFilters: (args: { window: SidebarWindowInput }) => {\n includes: string[];\n removes: string[];\n };\n setPageFilters: (args: {\n page: { uid?: string; title?: string };\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n setPageLinkedRefsFilters: (args: {\n page: { uid?: string; title?: string };\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n setSidebarWindowFilters: (args: {\n window: SidebarWindowInput;\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n };\n getFocusedBlock: () => null | {\n \"window-id\": string;\n \"block-uid\": string;\n };\n components: {\n renderBlock: (args: {\n uid: string;\n el: HTMLElement;\n \"zoom-path?\"?: boolean;\n // \"open?\"?: boolean; Not available yet in the API\n }) => null;\n renderPage: (args: {\n uid: string;\n el: HTMLElement;\n \"hide-mentions?\"?: boolean;\n }) => null;\n renderSearch: (args: {\n \"search-query-str\": string;\n el: HTMLElement;\n \"closed?\"?: boolean;\n \"group-by-page?\"?: boolean;\n \"hide-paths?\"?: boolean;\n \"config-changed-callback\"?: (config: unknown) => void;\n }) => null;\n // renderString: (args: { string: string; el: HTMLElement }) => null; Not available yet in the API\n unmountNode: (args: { el: HTMLElement }) => void;\n };\n graphView: {\n addCallback: (props: {\n label: string;\n callback: (context: {\n cytoscape: unknown;\n elements: unknown[];\n type: \"page\" | \"all-pages\";\n }) => void;\n type?: \"page\" | \"all-pages\";\n }) => Promise<void>;\n removeCallback: (props: { label: string }) => Promise<void>;\n wholeGraph: {\n addCallback: (props: {\n label: string;\n callback: (arg: { \"sigma-renderer\": unknown }) => void;\n }) => any;\n removeCallback: (props: { label: string }) => void;\n setExplorePages: (pages: string[]) => void;\n getExplorePages: () => string[];\n setMode: (mode: \"Whole Graph\" | \"Explore\") => void;\n };\n };\n mainWindow: {\n focusFirstBlock: () => Promise<void>;\n openBlock: (p: { block: { uid: string } }) => Promise<void>;\n openPage: (p: {\n page: { uid: string } | { title: string };\n }) => Promise<void>;\n getOpenPageOrBlockUid: () => Promise<string | null>;\n openDailyNotes: () => Promise<void>;\n };\n setBlockFocusAndSelection: (a: {\n location?: { \"block-uid\": string; \"window-id\": string };\n selection?: { start: number; end?: number };\n }) => Promise<void>;\n };\n platform: {\n isDesktop: boolean;\n isIOS: boolean;\n isMobile: boolean;\n isMobileApp: boolean;\n isPC: boolean;\n isTouchDevice: boolean;\n };\n graph: {\n name: string;\n type: \"hosted\" | \"offline\";\n isEncrypted: boolean;\n };\n file: {\n upload: (args: {\n file: File;\n toast?: { hide: boolean };\n }) => Promise<string>;\n get: (args: { url: string }) => Promise<File>;\n delete: (args: { url: string }) => Promise<void>;\n };\n user: {\n uid: () => string | null;\n };\n constants: {\n corsAnywhereProxyUrl: string;\n };\n };\n\n // roamjs namespace should only be used for methods that must be accessed across extension scripts\n roamjs: {\n loaded: Set<string>;\n extension: {\n queryBuilder?: {\n runQuery: RunQuery;\n runQuerySync: RunQuerySync;\n listActiveQueries: ListActiveQueries;\n isDiscourseNode: IsDiscourseNode;\n };\n smartblocks?: {\n registerCommand: RegisterCommand;\n unregisterCommand: UnregisterCommand;\n triggerSmartblock: (args: {\n srcName?: string;\n srcUid?: string;\n targetName?: string;\n targetUid?: string;\n variables?: Record<string, string>;\n }) => Promise<unknown>;\n };\n [id: string]: Record<string, unknown> | undefined;\n };\n version: { [id: string]: string };\n actions: Record<string, number>;\n };\n }\n}\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAmBA,mDAAyB","sourcesContent":["import {\n AddPullWatch,\n PullBlock,\n SidebarAction,\n SidebarWindow,\n SidebarWindowInput,\n WriteAction,\n} from \"./native\";\nimport {\n RunQuery,\n ListActiveQueries,\n RunQuerySync,\n IsDiscourseNode,\n} from \"./query-builder\";\nimport { RegisterCommand, UnregisterCommand } from \"./smartblocks\";\nimport type marked from \"marked\";\nimport type Markdown from \"marked-react\";\nimport type JSZip from \"jszip\";\nimport type cytoscape from \"cytoscape\";\nexport * from \"./native\";\n\nexport type Registry = {\n elements: HTMLElement[];\n reactRoots: HTMLElement[];\n observers: MutationObserver[];\n domListeners: (\n | {\n el: Window;\n type: keyof WindowEventMap;\n listener: (\n this: Window,\n ev: WindowEventMap[keyof WindowEventMap]\n ) => void;\n }\n | {\n el: Document;\n type: keyof DocumentEventMap;\n listener: (\n this: Document,\n ev: DocumentEventMap[keyof DocumentEventMap]\n ) => void;\n }\n | {\n el: HTMLElement;\n type: keyof HTMLElementEventMap | `roamjs:${string}`;\n listener: (\n this: HTMLElement,\n ev: HTMLElementEventMap[keyof HTMLElementEventMap]\n ) => void;\n }\n )[];\n commands: string[];\n timeouts: { timeout: number }[];\n};\n\ndeclare global {\n interface Window {\n // TODO remove\n RoamLazy?: {\n JSZip: () => Promise<typeof JSZip>;\n Marked: () => Promise<typeof marked>;\n MarkedReact: () => Promise<typeof Markdown>;\n Cytoscape: () => Promise<typeof cytoscape>;\n Insect: () => Promise<{\n // insect uses purescript instead of typescript -.-\n commands: string[];\n fmtConsole: (M: unknown) => unknown;\n fmtJqueryTerminal: (M: unknown) => unknown;\n fmtPlain: (M: unknown) => unknown;\n functions: (M: unknown) => unknown;\n identifiers: (M: unknown) => unknown;\n initialEnvironment: { values: unknown; functions: unknown };\n repl: (\n fmt: (M: unknown) => unknown\n ) => (env: {\n values: unknown;\n functions: unknown;\n }) => (s: string) => { msg: string };\n }>;\n };\n // END TODO remove\n\n roamAlphaAPI: {\n q: (query: string, ...params: unknown[]) => unknown[][];\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => PullBlock;\n createBlock: WriteAction;\n updateBlock: WriteAction;\n createPage: WriteAction;\n moveBlock: WriteAction;\n deleteBlock: WriteAction;\n updatePage: WriteAction;\n deletePage: WriteAction;\n util: {\n generateUID: () => string;\n dateToPageTitle: (date: Date) => string;\n dateToPageUid: (date: Date) => string;\n pageTitleToDate: (title: string) => Date | null;\n uploadFile: (args: { file: File }) => string;\n };\n data: {\n addPullWatch: AddPullWatch;\n block: {\n create: WriteAction;\n update: WriteAction;\n move: WriteAction;\n delete: WriteAction;\n reorderBlocks: (args: {\n location: { \"parent-uid\": string };\n blocks: string[];\n }) => Promise<void>;\n };\n fast: {\n q: (query: string, ...params: unknown[]) => unknown[][];\n };\n async: {\n q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => Promise<PullBlock>;\n pull_many: (\n pattern: string,\n eids: string[][]\n ) => Promise<PullBlock[]>;\n fast: {\n q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;\n };\n };\n backend: {\n q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;\n };\n page: {\n create: WriteAction;\n update: WriteAction;\n delete: WriteAction;\n };\n pull: (\n selector: string,\n id: number | string | [string, string]\n ) => PullBlock;\n pull_many: (pattern: string, eids: string[][]) => PullBlock[];\n q: (query: string, ...params: unknown[]) => unknown[][];\n removePullWatch: (\n pullPattern: string,\n entityId: string,\n callback?: (before: PullBlock, after: PullBlock) => void\n ) => boolean;\n redo: () => void;\n undo: () => void;\n user: {\n upsert: () => void;\n };\n };\n ui: {\n leftSidebar: {\n open: () => Promise<void>;\n close: () => Promise<void>;\n };\n rightSidebar: {\n open: () => Promise<void>;\n close: () => Promise<void>;\n getWindows: () => SidebarWindow[];\n addWindow: SidebarAction;\n setWindowOrder: SidebarAction;\n collapseWindow: SidebarAction;\n pinWindow: (action: {\n window: SidebarWindowInput;\n \"pin-to-top?\"?: boolean;\n }) => Promise<void>;\n expandWindow: SidebarAction;\n removeWindow: SidebarAction;\n unpinWindow: SidebarAction;\n };\n commandPalette: {\n addCommand: (action: {\n label: string;\n callback: () => void;\n \"disable-hotkey\"?: boolean;\n \"default-hotkey\"?: string | string[];\n }) => Promise<void>;\n removeCommand: (action: { label: string }) => Promise<void>;\n };\n blockContextMenu: {\n addCommand: (action: {\n label: string;\n callback: (props: {\n \"block-string\": string;\n \"block-uid\": string;\n heading: 0 | 1 | 2 | 3 | null;\n \"page-uid\": string;\n \"read-only?\": boolean;\n \"window-id\": string;\n }) => void;\n }) => void;\n removeCommand: (action: { label: string }) => void;\n };\n individualMultiselect: {\n getSelectedUids: () => string[];\n };\n msContextMenu: {\n addCommand: (action: {\n label: string;\n callback: () => void;\n \"display-conditional\"?: () => boolean;\n }) => void;\n removeCommand: (action: { label: string }) => void;\n };\n filters: {\n addGlobalFilter: (args: {\n title: string;\n type: \"includes\" | \"removes\";\n }) => Promise<void>;\n removeGlobalFilter: (args: {\n title: string;\n type: \"includes\" | \"removes\";\n }) => Promise<void>;\n getGlobalFilters: () => { includes: string[]; removes: string[] };\n getPageFilters: (args: {\n page: { uid?: string; title?: string };\n }) => {\n includes: string[];\n removes: string[];\n };\n getPageLinkedRefsFilters: (args: {\n page: { uid?: string; title?: string };\n }) => {\n includes: string[];\n removes: string[];\n };\n getSidebarWindowFilters: (args: { window: SidebarWindowInput }) => {\n includes: string[];\n removes: string[];\n };\n setPageFilters: (args: {\n page: { uid?: string; title?: string };\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n setPageLinkedRefsFilters: (args: {\n page: { uid?: string; title?: string };\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n setSidebarWindowFilters: (args: {\n window: SidebarWindowInput;\n filters: { includes?: string[]; removes?: string[] };\n }) => Promise<void>;\n };\n getFocusedBlock: () => null | {\n \"window-id\": string;\n \"block-uid\": string;\n };\n components: {\n renderBlock: (args: {\n uid: string;\n el: HTMLElement;\n \"zoom-path?\"?: boolean;\n // \"open?\"?: boolean; Not available yet in the API\n }) => null;\n renderPage: (args: {\n uid: string;\n el: HTMLElement;\n \"hide-mentions?\"?: boolean;\n }) => null;\n renderSearch: (args: {\n \"search-query-str\": string;\n el: HTMLElement;\n \"closed?\"?: boolean;\n \"group-by-page?\"?: boolean;\n \"hide-paths?\"?: boolean;\n \"config-changed-callback\"?: (config: unknown) => void;\n }) => null;\n // renderString: (args: { string: string; el: HTMLElement }) => null; Not available yet in the API\n unmountNode: (args: { el: HTMLElement }) => void;\n };\n graphView: {\n addCallback: (props: {\n label: string;\n callback: (context: {\n cytoscape: unknown;\n elements: unknown[];\n type: \"page\" | \"all-pages\";\n }) => void;\n type?: \"page\" | \"all-pages\";\n }) => Promise<void>;\n removeCallback: (props: { label: string }) => Promise<void>;\n wholeGraph: {\n addCallback: (props: {\n label: string;\n callback: (arg: { \"sigma-renderer\": unknown }) => void;\n }) => any;\n removeCallback: (props: { label: string }) => void;\n setExplorePages: (pages: string[]) => void;\n getExplorePages: () => string[];\n setMode: (mode: \"Whole Graph\" | \"Explore\") => void;\n };\n };\n mainWindow: {\n focusFirstBlock: () => Promise<void>;\n openBlock: (p: { block: { uid: string } }) => Promise<void>;\n openPage: (p: {\n page: { uid: string } | { title: string };\n }) => Promise<void>;\n getOpenPageOrBlockUid: () => Promise<string | null>;\n openDailyNotes: () => Promise<void>;\n };\n setBlockFocusAndSelection: (a: {\n location?: { \"block-uid\": string; \"window-id\": string };\n selection?: { start: number; end?: number };\n }) => Promise<void>;\n };\n platform: {\n isDesktop: boolean;\n isIOS: boolean;\n isMobile: boolean;\n isMobileApp: boolean;\n isPC: boolean;\n isTouchDevice: boolean;\n };\n graph: {\n name: string;\n type: \"hosted\" | \"offline\";\n isEncrypted: boolean;\n };\n file: {\n upload: (args: {\n file: File;\n toast?: { hide: boolean };\n }) => Promise<string>;\n get: (args: { url: string }) => Promise<File>;\n delete: (args: { url: string }) => Promise<void>;\n };\n user: {\n uid: () => string | null;\n };\n constants: {\n corsAnywhereProxyUrl: string;\n };\n };\n\n // roamjs namespace should only be used for methods that must be accessed across extension scripts\n roamjs: {\n loaded: Set<string>;\n extension: {\n queryBuilder?: {\n runQuery: RunQuery;\n runQuerySync: RunQuerySync;\n listActiveQueries: ListActiveQueries;\n isDiscourseNode: IsDiscourseNode;\n };\n smartblocks?: {\n registerCommand: RegisterCommand;\n unregisterCommand: UnregisterCommand;\n triggerSmartblock: (args: {\n srcName?: string;\n srcUid?: string;\n targetName?: string;\n targetUid?: string;\n variables?: Record<string, string>;\n }) => Promise<unknown>;\n };\n [id: string]: Record<string, unknown> | undefined;\n };\n version: { [id: string]: string };\n actions: Record<string, number>;\n };\n }\n}\n"]}