@note3/utils 0.1.5 → 0.1.7

package/dist/tree-builder.d.ts

@@ -0,0 +1,117 @@
+import type { ApplogForInsertOptionalAgent, EntityID } from '@wovin/core/applog';
+import type { TiptapContent } from './note3-utils-nodeps';
+/**
+ * Represents a single node in a tree structure.
+ * Content can be a string or a Tiptap JSON object.
+ * Children are optional and can be recursively nested.
+ */
+export interface TreeNode {
+    /** Content as string or Tiptap object (auto-serialized) */
+    content: string | TiptapContent;
+    /** Optional child nodes */
+    children?: TreeNode[];
+}
+/**
+ * Result of creating a single node with its applogs
+ */
+export interface NodeCreationResult {
+    blockID: EntityID;
+    applogs: ApplogForInsertOptionalAgent[];
+}
+/**
+ * Result of creating a tree with applogs
+ */
+export interface TreeCreationResult {
+    rootIDs: EntityID[];
+    applogs: ApplogForInsertOptionalAgent[];
+}
+/**
+ * Creates block applogs for a single piece of content.
+ * Generates an entity ID using getHashID, including positional context
+ * (parent and after) to ensure uniqueness even for identical content.
+ *
+ * @param content - String or TiptapContent object
+ * @param parentID - Optional parent ID for positional context in hash
+ * @param after - Optional previous sibling ID for positional context in hash
+ * @param entityID - Optional pre-computed entity ID
+ * @returns Object with generated entityID and applogs array
+ */
+export declare function createBlockApplogs(content: string | TiptapContent, parentID?: EntityID, after?: EntityID | null, entityID?: EntityID): {
+    en: EntityID;
+    applogs: ApplogForInsertOptionalAgent[];
+};
+/**
+ * Creates relation applogs that connect a block as a child of a parent.
+ * Generates three applogs: one for the block reference, one for the parent reference,
+ * and one for the sibling ordering (after).
+ *
+ * @param blockID - The ID of the child block
+ * @param childOf - The ID of the parent block
+ * @param after - The ID of the previous sibling (or null if first child)
+ * @param relationID - Optional pre-computed relation entity ID
+ * @returns Object with relation entity ID and applogs array
+ */
+export declare function createRelationApplogs(blockID: EntityID, childOf: EntityID, after: EntityID | null, relationID?: EntityID): {
+    en: EntityID;
+    applogs: ApplogForInsertOptionalAgent[];
+};
+/**
+ * Recursively creates applogs for a single node and its children.
+ * Maintains proper sibling ordering using the 'after' field.
+ *
+ * @param node - The node to create
+ * @param parentID - Optional parent block ID. If provided, creates a relation to parent.
+ * @param after - Optional previous sibling ID for proper ordering
+ * @returns Object with block ID and flattened applogs array
+ */
+export declare function createSingleNodeApplogs(node: TreeNode, parentID?: EntityID, after?: EntityID | null): NodeCreationResult;
+/**
+ * Creates applogs for multiple root nodes (nodes without a parent).
+ * All nodes are created as standalone roots.
+ *
+ * @param nodes - Array of root nodes
+ * @returns Object with array of root IDs and flattened applogs
+ *
+ * @example
+ * const nodes: TreeNode[] = [
+ *   { content: 'Root 1', children: [{ content: 'Child 1' }] },
+ *   { content: 'Root 2' }
+ * ]
+ * const { rootIDs, applogs } = createTreeApplogs(nodes)
+ */
+export declare function createTreeApplogs(nodes: TreeNode[]): TreeCreationResult;
+/**
+ * Creates applogs for multiple nodes as children of a parent.
+ * All nodes are created as children of the specified parent.
+ *
+ * @param nodes - Array of nodes
+ * @param parentID - Parent block ID. Nodes will be created as children of this parent.
+ * @returns Object with array of created block IDs and flattened applogs
+ *
+ * @example
+ * const subtree: TreeNode[] = [
+ *   { content: 'Child 1' },
+ *   { content: 'Child 2' }
+ * ]
+ * const { rootIDs, applogs } = createTreeApplogs(subtree, 'existingParentID')
+ */
+export declare function createTreeApplogs(nodes: TreeNode[], parentID: EntityID): TreeCreationResult;
+/**
+ * Creates applogs for a single root node with its descendants.
+ * Convenience function that returns just the root block ID instead of an array.
+ *
+ * @param root - The root node
+ * @returns Object with root block ID and applogs
+ *
+ * @example
+ * const node: TreeNode = {
+ *   content: 'Parent',
+ *   children: [
+ *     { content: 'Child 1' },
+ *     { content: 'Child 2' }
+ *   ]
+ * }
+ * const { blockID, applogs } = createSingleTree(node)
+ */
+export declare function createSingleTree(root: TreeNode): NodeCreationResult;
+//# sourceMappingURL=tree-builder.d.ts.map

package/dist/tree-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-builder.d.ts","sourceRoot":"","sources":["../src/tree-builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAEhF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACxB,2DAA2D;IAC3D,OAAO,EAAE,MAAM,GAAG,aAAa,CAAA;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,QAAQ,CAAA;IACjB,OAAO,EAAE,4BAA4B,EAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,QAAQ,EAAE,CAAA;IACnB,OAAO,EAAE,4BAA4B,EAAE,CAAA;CACvC;AAWD;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,MAAM,GAAG,aAAa,EAC/B,QAAQ,CAAC,EAAE,QAAQ,EACnB,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,EACvB,QAAQ,CAAC,EAAE,QAAQ,GACjB;IAAE,EAAE,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,4BAA4B,EAAE,CAAA;CAAE,CAc3D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,QAAQ,EACjB,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,QAAQ,GAAG,IAAI,EACtB,UAAU,CAAC,EAAE,QAAQ,GACnB;IAAE,EAAE,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,4BAA4B,EAAE,CAAA;CAAE,CAa3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACtC,IAAI,EAAE,QAAQ,EACd,QAAQ,CAAC,EAAE,QAAQ,EACnB,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,GACrB,kBAAkB,CA2BpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,kBAAkB,CAAA;AACxE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,GAAG,kBAAkB,CAAA;AAoB5F;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,kBAAkB,CAEnE"}

package/dist/tree-builder.min.js

@@ -0,0 +1,2 @@
+import{a,b,c,d,e}from"./chunk-ZJUZ7RVG.min.js";import"./chunk-YXZYW2WJ.min.js";import"./chunk-MXMMU6NF.min.js";export{a as createBlockApplogs,b as createRelationApplogs,c as createSingleNodeApplogs,e as createSingleTree,d as createTreeApplogs};
+//# sourceMappingURL=tree-builder.min.js.map

package/dist/tree-builder.min.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types.d.ts

@@ -0,0 +1,20 @@
+import type { EntityID } from '@wovin/core/applog';
+export interface RelationInfo {
+    /** The relation's entity ID */
+    id: EntityID;
+    /** The child block ID */
+    block: EntityID;
+    /** The parent block ID */
+    childOf: EntityID;
+    /** Sibling ordering - ID of the block this should come after */
+    after: EntityID | null;
+    /** Whether the relation is expanded in UI */
+    isExpanded?: boolean;
+    /** Whether this is a mirror relation */
+    isMirror?: boolean;
+    /** Whether this is a reply relation */
+    isReply?: boolean;
+    /** Whether the relation is deleted */
+    isDeleted?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,WAAW,YAAY;IAC5B,+BAA+B;IAC/B,EAAE,EAAE,QAAQ,CAAA;IACZ,yBAAyB;IACzB,KAAK,EAAE,QAAQ,CAAA;IACf,0BAA0B;IAC1B,OAAO,EAAE,QAAQ,CAAA;IACjB,gEAAgE;IAChE,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;IACtB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,uCAAuC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAA;CACnB"}

package/dist/types.min.js

@@ -0,0 +1,2 @@
+import"./chunk-KHOUPFOL.min.js";
+//# sourceMappingURL=types.min.js.map

package/dist/types.min.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/url-parsing.d.ts

@@ -0,0 +1,138 @@
+interface HashFragments {
+    [key: string]: string | null;
+}
+/**
+ * Parse hash fragments from a URL hash string
+ *
+ * @param hash The hash string (with or without leading #)
+ * @returns An object with key-value pairs from the hash fragments
+ */
+export declare function parseHashFragments(hash: string): HashFragments;
+/**
+ * Get a specific hash fragment value from a URL
+ *
+ * @param url The URL object
+ * @param key The fragment key to retrieve
+ * @returns The value of the hash fragment, or null if not found
+ */
+export declare function getHashFragment(url: URL, key: string): string | null;
+/**
+ * Convert a hash fragment object to a string
+ *
+ * @param fragments The hash fragments object
+ * @returns Hash string ready to be set as url.hash
+ */
+export declare function hashFragmentsToString(fragments: HashFragments): string;
+/**
+ * Set a hash fragment on a URL. Modifies the URL in place.
+ *
+ * @param url The URL to modify
+ * @param key The fragment key
+ * @param value The fragment value (null to include key without value)
+ */
+export declare function setHashFragment(url: URL, key: string, value: string | null): void;
+/**
+ * Delete a hash fragment from a URL. Modifies the URL in place.
+ *
+ * @param url The URL to modify
+ * @param key The fragment key to remove
+ */
+export declare function deleteHashFragment(url: URL, key: string): void;
+/**
+ * Check if a hash fragment exists in a URL
+ *
+ * @param url The URL to check
+ * @param key The fragment key
+ * @returns true if the hash fragment exists
+ */
+export declare function hasHashFragment(url: URL, key: string): boolean;
+/** Canonical Note3 origins */
+export declare const CANONICAL_NOTE3_ORIGINS: readonly ["https://note3.app", "https://dev.note3.app"];
+/**
+ * Get all known Note3 origins, including current browser origin if applicable
+ *
+ * Includes current origin when NOT on a path-based IPFS/IPNS gateway
+ * (i.e., when pathname doesn't start with /ipfs or /ipns)
+ *
+ * @returns Array of origins that should be treated as Note3 URLs
+ */
+export declare function getKnownNote3Origins(): string[];
+/**
+ * Safe wrapper for URL constructor. Returns null instead of throwing.
+ *
+ * @param value The URL string to parse
+ * @returns Parsed URL object, or null if parsing fails
+ */
+export declare function tryParseURL(value: string): URL | null;
+interface Note3URLParts {
+    share?: string;
+    preview?: boolean;
+    focus?: string;
+}
+/**
+ * Parse a Note3 URL in either note3:// protocol or hash-based format
+ *
+ * Supports formats:
+ * - note3://share/{pubkey}
+ * - https://note3.app#/block/{id}?share={pubkey}
+ * - https://note3.app#/block/{id}?preview={pubkey}
+ *
+ * @param value The URL string to parse
+ * @returns Object with share, preview, and focus properties, or null if not a valid Note3 URL
+ */
+export declare function tryParseNote3URL(value: string): Note3URLParts | null;
+/**
+ * Create a Note3 URL with optional share or block parameters
+ *
+ * @param pub The public share key
+ * @param block The block ID to focus on
+ * @param previewPub If true, use preview parameter instead of share
+ * @param relative If true, return a relative URL without origin/protocol
+ * @returns Formatted Note3 URL
+ */
+export declare function makeNote3Url({ pub, block, previewPub, relative, }: {
+    pub?: string;
+    block?: string;
+    previewPub?: boolean;
+    relative?: boolean;
+}): string;
+/**
+ * Extract search parameters from the hash portion of a URL
+ *
+ * Useful for Note3 URLs where parameters appear after ? in the hash
+ * e.g., https://note3.app#/block/abc123?share=xyz
+ *
+ * @param hashPartOfUrl The hash string (defaults to window.location.hash)
+ * @returns URLSearchParams or null if no query parameters in hash
+ * @deprecated Consider using standard URL parsing instead for new code
+ */
+export declare function searchParamsFromHash(hashPartOfUrl?: string): URLSearchParams | null;
+/**
+ * Replace search parameters in a URL
+ *
+ * @param location Location-like object with pathname and query
+ * @param params Object with key-value pairs to set
+ * @returns New URL string with updated parameters
+ */
+export declare function replaceSearchParamsInUrl(location: {
+    pathname?: string;
+    query?: Record<string, string> | string;
+}, params: Record<string, string | null | undefined>): string;
+/**
+ * Merge partial location/URI parts with existing location
+ *
+ * @param location The current location object
+ * @param replace Partial location with fields to replace
+ * @returns Full URI string with pathname, search, and hash
+ */
+export declare function replaceUriParts(location: {
+    pathname?: string;
+    search?: string;
+    hash?: string;
+}, replace: Partial<{
+    pathname?: string;
+    search?: string;
+    hash?: string;
+}>): string;
+export {};
+//# sourceMappingURL=url-parsing.d.ts.map

package/dist/url-parsing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-parsing.d.ts","sourceRoot":"","sources":["../src/url-parsing.ts"],"names":[],"mappings":"AAQA,UAAU,aAAa;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAC7B;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAoB9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,aAAa,GAAG,MAAM,CAStE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAKjF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAG9D;AAMD,8BAA8B;AAC9B,eAAO,MAAM,uBAAuB,yDAG1B,CAAA;AAEV;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,EAAE,CAa/C;AAKD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAMrD;AAED,UAAU,aAAa;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAkCpE;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,EACE,GAAG,EACH,KAAK,EACL,UAAkB,EAClB,QAAgB,GACjB,EAAE;IACD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,GACA,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAInF;AAMD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;CAAE,EACxE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GAChD,MAAM,CAcR;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EAC/D,OAAO,EAAE,OAAO,CAAC;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GACtE,MAAM,CAMR"}

package/dist/url-parsing.min.js

@@ -0,0 +1,2 @@
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n}from"./chunk-4ARVEMAY.min.js";import"./chunk-5TTMWYXD.min.js";import"./chunk-MXMMU6NF.min.js";export{g as CANONICAL_NOTE3_ORIGINS,e as deleteHashFragment,b as getHashFragment,h as getKnownNote3Origins,f as hasHashFragment,c as hashFragmentsToString,k as makeNote3Url,a as parseHashFragments,m as replaceSearchParamsInUrl,n as replaceUriParts,l as searchParamsFromHash,d as setHashFragment,j as tryParseNote3URL,i as tryParseURL};
+//# sourceMappingURL=url-parsing.min.js.map

package/dist/url-parsing.min.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@note3/utils",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "type": "module",
   "private": false,
   "main": "./dist/index.min.js",
@@ -31,7 +31,7 @@
     "comlink": "^4.4.2",
     "core-js": "^3.45.1",
     "vite-plugin-comlink": "^5.3.0",
-    "@wovin/core": "^0.1.5"
+    "@wovin/core": "^0.1.7"
   },
   "devDependencies": {
     "concurrently": "^8.2.2",