@texonom/nutils 1.4.7 → 1.5.0

package/build/find-ancestors.d.ts

@@ -1,3 +1,3 @@
-import type { ExtendedRecordMap, Block, Collection } from '@texonom/ntypes';
+import { ExtendedRecordMap, Block, Collection } from '@texonom/ntypes';
 export declare function findAncestors(recordMap: ExtendedRecordMap, block: Block | Collection, list?: string[]): string[];
 //# sourceMappingURL=find-ancestors.d.ts.map

package/build/get-all-in-space.d.ts

@@ -1,4 +1,4 @@
-import type { ExtendedRecordMap, PageMap, PageChunk } from '@texonom/ntypes';
+import { ExtendedRecordMap, PageMap, PageChunk } from '@texonom/ntypes';
 export type PageTree = {
     id: string;
     type: string;

package/build/get-block-collection-id.d.ts

@@ -1,3 +1,3 @@
-import type { Block, ExtendedRecordMap } from '@texonom/ntypes';
+import { Block, ExtendedRecordMap } from '@texonom/ntypes';
 export declare function getBlockCollectionId(block: Block, recordMap: ExtendedRecordMap): string | null;
 //# sourceMappingURL=get-block-collection-id.d.ts.map

package/build/get-block-icon.d.ts

@@ -1,3 +1,3 @@
-import type { Block, ExtendedRecordMap } from '@texonom/ntypes';
+import { Block, ExtendedRecordMap } from '@texonom/ntypes';
 export declare function getBlockIcon(block: Block, recordMap: ExtendedRecordMap): string;
 //# sourceMappingURL=get-block-icon.d.ts.map

package/build/get-block-parent-page.d.ts

@@ -1,4 +1,4 @@
-import type { Block, ExtendedRecordMap, PageBlock, Collection, Space } from '@texonom/ntypes';
+import { Block, ExtendedRecordMap, PageBlock, Collection, Space } from '@texonom/ntypes';
 /**
  * Returns the parent page block containing a given page.
  *

package/build/get-block-title.d.ts

@@ -1,3 +1,3 @@
-import type { Block, ExtendedRecordMap } from '@texonom/ntypes';
+import { Block, ExtendedRecordMap } from '@texonom/ntypes';
 export declare function getBlockTitle(block: Block, recordMap: ExtendedRecordMap): string;
 //# sourceMappingURL=get-block-title.d.ts.map

package/build/get-canonical-page-id.d.ts

@@ -1,4 +1,4 @@
-import type { ExtendedRecordMap } from '@texonom/ntypes';
+import { ExtendedRecordMap } from '@texonom/ntypes';
 /**
  * Gets the canonical, display-friendly version of a page's ID for use in URLs.
  */

package/build/get-date-value.d.ts

@@ -1,4 +1,4 @@
-import type { FormattedDate } from '@texonom/ntypes';
+import { FormattedDate } from '@texonom/ntypes';
 /**
  * Attempts to find a valid date from a given property.
  */

package/build/get-page-breadcrumbs.d.ts

@@ -1,3 +1,3 @@
-import type { ExtendedRecordMap } from '@texonom/ntypes';
+import { ExtendedRecordMap } from '@texonom/ntypes';
 export declare const getPageBreadcrumbs: (recordMap: ExtendedRecordMap, activePageId: string) => Array<any> | null;
 //# sourceMappingURL=get-page-breadcrumbs.d.ts.map

package/build/get-page-content-block-ids.d.ts

@@ -1,4 +1,4 @@
-import type { ExtendedRecordMap } from '@texonom/ntypes';
+import { ExtendedRecordMap } from '@texonom/ntypes';
 /**
  * Gets the IDs of all blocks contained on a page starting from a root block ID.
  */

package/build/get-page-image-urls.d.ts

@@ -1,4 +1,4 @@
-import type { Block, ExtendedRecordMap } from '@texonom/ntypes';
+import { Block, ExtendedRecordMap } from '@texonom/ntypes';
 /**
  * Gets URLs of all images contained on the given page.
  */

package/build/get-page-table-of-contents.d.ts

@@ -1,4 +1,4 @@
-import type { ID, BlockType, PageBlock, ExtendedRecordMap } from '@texonom/ntypes';
+import { ID, BlockType, PageBlock, ExtendedRecordMap } from '@texonom/ntypes';
 export interface TableOfContentsEntry {
     id: ID;
     type: BlockType;

package/build/get-page-title.d.ts

@@ -1,3 +1,3 @@
-import type { ExtendedRecordMap } from '@texonom/ntypes';
+import { ExtendedRecordMap } from '@texonom/ntypes';
 export declare function getPageTitle(recordMap: ExtendedRecordMap): string;
 //# sourceMappingURL=get-page-title.d.ts.map

package/build/get-text-content.d.ts

@@ -1,4 +1,4 @@
-import type { Decoration } from '@texonom/ntypes';
+import { Decoration } from '@texonom/ntypes';
 /**
  * Gets the raw, unformatted text content of a block's content value.
  *

package/build/index.d.ts

@@ -1,208 +1,28 @@
-import { Decoration, Block, ExtendedRecordMap, FormattedDate, PageBlock, Collection, Space, ID, BlockType, PageChunk, PageMap } from '@texonom/ntypes';
-export { default as isUrl } from 'is-url-superb';
-
-/**
- * Gets the raw, unformatted text content of a block's content value.
- *
- * This is useful, for instance, for extracting a block's `title` without any
- * rich text formatting.
- */
-declare const getTextContent: (text?: Decoration[]) => string;
-
-declare function getBlockTitle(block: Block, recordMap: ExtendedRecordMap): string;
-
-declare function getBlockIcon(block: Block, recordMap: ExtendedRecordMap): string;
-
-declare function getBlockCollectionId(block: Block, recordMap: ExtendedRecordMap): string | null;
-
-declare function getPageTitle(recordMap: ExtendedRecordMap): string;
-
-/**
- * Gets the value of a collection property for a given page (collection item).
- *
- * @param propertyName property name
- * @param block Page block, often be first block in blockMap
- * @param recordMap
- * @returns - The return value types will follow the following principles:
- *  1. if property is date type, it will return `number` or `number[]`(depends on `End Date` switch)
- *  2. property is text-like will return `string`
- *  3. multi select property will return `string[]`
- *  4. checkbox property return `boolean`
- * @todo complete all no-text property type
- */
-declare function getPageProperty<T = string | number | boolean | string[] | number[]>(propertyName: string, block: Block, recordMap: ExtendedRecordMap): T;
-
-/**
- * Attempts to find a valid date from a given property.
- */
-declare const getDateValue: (prop: any[]) => FormattedDate | null;
-
-/**
- * Returns the parent page block containing a given page.
- *
- * Note that many times this will not be the direct parent block since
- * some non-page content blocks can contain sub-blocks.
- */
-declare const getBlockParentPage: (block: Block, recordMap: ExtendedRecordMap, { inclusive }?: {
-    inclusive?: boolean;
-}) => PageBlock | null;
-declare const getBlockParent: (block: Block, recordMap: ExtendedRecordMap, { inclusive }?: {
-    inclusive?: boolean;
-}) => PageBlock | Collection | Space;
-
-interface TableOfContentsEntry {
-    id: ID;
-    type: BlockType;
-    text: string;
-    indentLevel: number;
-}
-/**
- * Gets the metadata for a table of contents block by parsing the page's
- * H1, H2, and H3 elements.
- */
-declare const getPageTableOfContents: (page: PageBlock, recordMap: ExtendedRecordMap) => Array<TableOfContentsEntry>;
-
-/**
- * Gets the IDs of all blocks contained on a page starting from a root block ID.
- */
-declare const getPageContentBlockIds: (recordMap: ExtendedRecordMap, blockId?: string, locust?: boolean) => string[];
-/**
- * Gets the IDs of all blocks contained on a page starting from a root block ID.
- */
-declare const getPageContentUserIds: (recordMap: ExtendedRecordMap, blockId?: string) => string[];
-
-/**
- * Robustly extracts the notion page ID from a notion URL or pathname suffix.
- *
- * Defaults to returning a UUID (with dashes).
- */
-declare const parsePageId: (id?: string | null, { uuid }?: {
-    uuid?: boolean;
-}) => string;
-
-declare const idToUuid: (id?: string) => string;
-
-declare const uuidToId: (uuid: string) => string;
-
-type PageTree = {
-    id: string;
-    type: string;
-    title: string;
-    blocks: number;
-    pages: number;
-    parent?: PageTree;
-    children: PageTree[];
-};
-type FetchOption = RequestInit & {
-    timeout?: number;
-};
-/**
- * Performs a traversal over a given Notion workspace starting from a seed page.
- *
- * Returns a map containing all of the pages that are reachable from the seed
- * page in the space.
- *
- * If `rootSpaceId` is not defined, the space ID of the root page will be used
- * to scope traversal.
- *
- *
- * @param rootPageId - Page ID to start from.
- * @param rootSpaceId - Space ID to scope traversal.
- * @param getPage - Function used to fetch a single page.
- * @param opts - Optional config
- */
-declare function getAllInSpace(startPageId: string, getPage: (pageId: string, { fetchOption }?: {
-    fetchOption?: FetchOption;
-}) => Promise<ExtendedRecordMap>, getBlocks: (blockIds: string[], fetchOption?: FetchOption) => Promise<PageChunk>, fetchCollections: (contentBlockIds: string[], recordMap: ExtendedRecordMap, pageId?: string, { fetchOption, concurrency, collectionConcurrency }?: {
-    fetchOption?: FetchOption;
-    concurrency: number;
-    collectionConcurrency?: number;
-}) => Promise<ExtendedRecordMap>, { startRecordMap, fetchOption, maxPage, debug, concurrency, collectionConcurrency }?: {
-    startRecordMap?: ExtendedRecordMap;
-    fetchOption?: FetchOption;
-    concurrency?: number;
-    maxPage?: number;
-    debug?: boolean;
-    collectionConcurrency?: number;
-}): Promise<{
-    recordMap: ExtendedRecordMap;
-    pageMap: PageMap;
-    pageTree: PageTree;
-}>;
-declare function recursivePageTree(recordMap: ExtendedRecordMap, pageTree: PageTree): PageTree;
-declare function getPageSync(pageId: string, recordMap: ExtendedRecordMap, getBlocks: (blockIds: string[], fetchOption?: FetchOption) => Promise<PageChunk>): Promise<ExtendedRecordMap>;
-
-/**
- * Gets the canonical, display-friendly version of a page's ID for use in URLs.
- */
-declare const getCanonicalPageId: (pageId: string, recordMap: ExtendedRecordMap, { uuid }?: {
-    uuid?: boolean;
-}) => string | null;
-
-declare const getPageBreadcrumbs: (recordMap: ExtendedRecordMap, activePageId: string) => Array<any> | null;
-
-/**
- * Gets URLs of all images contained on the given page.
- */
-declare const getPageImageUrls: (recordMap: ExtendedRecordMap, { mapImageUrl }: {
-    mapImageUrl: (url: string, block: Block) => string | null;
-}) => string[];
-
-declare const normalizeUrl: (url?: string) => string;
-
-declare const normalizeTitle: (title?: string | null) => string;
-
-declare function mergeRecordMaps(recordMapA: ExtendedRecordMap, recordMapB: ExtendedRecordMap): ExtendedRecordMap;
-
-declare const formatDate: (input: string | number, { month }?: {
-    month?: "long" | "short";
-}) => string;
-
-interface NotionDateTime {
-    type: 'datetime';
-    start_date: string;
-    start_time?: string;
-    time_zone?: string;
-}
-declare const formatNotionDateTime: (datetime: NotionDateTime) => string;
-
-declare function findAncestors(recordMap: ExtendedRecordMap, block: Block | Collection, list?: string[]): string[];
-
-type EstimatePageReadTimeOptions = {
-    wordsPerMinute?: number;
-    imageReadTimeInSeconds?: number;
-};
-type ContentStats = {
-    numWords: number;
-    numImages: number;
-};
-type PageReadTimeEstimate = ContentStats & {
-    totalWordsReadTimeInMinutes: number;
-    totalImageReadTimeInMinutes: number;
-    totalReadTimeInMinutes: number;
-};
-/**
- * Returns an estimate for the time it would take for a person to read the content
- * in the given Notion page.
- *
- * Uses Medium for inspiration.
- *
- * @see https://blog.medium.com/read-time-and-you-bc2048ab620c
- * @see https://github.com/ngryman/reading-time
- *
- * TODO: handle non-english content.
- */
-declare function estimatePageReadTime(block: Block, recordMap: ExtendedRecordMap, { wordsPerMinute, imageReadTimeInSeconds }?: EstimatePageReadTimeOptions): PageReadTimeEstimate;
-/**
- * Same as `estimatePageReadTime`, except it returns the total time estimate as
- * a human-readable string.
- *
- * For example, "9 minutes" or "less than a minute".
- */
-declare function estimatePageReadTimeAsHumanizedString(block: Block, recordMap: ExtendedRecordMap, opts: EstimatePageReadTimeOptions): string;
-
-declare const defaultMapImageUrl: (url: string, block: Block) => string | null;
-
-declare const defaultMapPageUrl: (rootPageId?: string) => (pageId: string) => string;
-
-export { type NotionDateTime, type PageTree, type TableOfContentsEntry, defaultMapImageUrl, defaultMapPageUrl, estimatePageReadTime, estimatePageReadTimeAsHumanizedString, findAncestors, formatDate, formatNotionDateTime, getAllInSpace, getBlockCollectionId, getBlockIcon, getBlockParent, getBlockParentPage, getBlockTitle, getCanonicalPageId, getDateValue, getPageBreadcrumbs, getPageContentBlockIds, getPageContentUserIds, getPageImageUrls, getPageProperty, getPageSync, getPageTableOfContents, getPageTitle, getTextContent, idToUuid, mergeRecordMaps, normalizeTitle, normalizeUrl, parsePageId, recursivePageTree, uuidToId };
+export * from './get-text-content';
+export * from './get-block-title';
+export * from './get-block-icon';
+export * from './get-block-collection-id';
+export * from './get-page-title';
+export * from './get-page-property';
+export * from './get-date-value';
+export * from './get-block-parent-page';
+export * from './get-page-table-of-contents';
+export * from './get-page-content-block-ids';
+export * from './parse-page-id';
+export * from './id-to-uuid';
+export * from './uuid-to-id';
+export * from './get-all-in-space';
+export * from './get-canonical-page-id';
+export * from './get-page-breadcrumbs';
+export * from './get-page-image-urls';
+export * from './is-url';
+export * from './normalize-url';
+export * from './normalize-title';
+export * from './merge-record-maps';
+export * from './format-date';
+export * from './format-notion-date-time';
+export * from './find-ancestors';
+export * from './estimate-page-read-time';
+export * from './map-image-url';
+export * from './map-page-url';
+//# sourceMappingURL=index.d.ts.map