orgnote-api 0.17.5 → 0.18.0

package/index.d.ts

@@ -4,4 +4,5 @@ import type * as ast from 'org-mode-ast';
 export * from './encryption';
 export * from './tools';
 export * from './files-api';
+export * from './mappers';
 export { ast };

package/index.js

@@ -3,3 +3,4 @@ export * from './models';
 export * from './encryption';
 export * from './tools';
 export * from './files-api';
+export * from './mappers';

package/mappers/index.d.ts

@@ -0,0 +1 @@
+export * from './orgnode-to-note';

package/mappers/index.js

@@ -0,0 +1 @@
+export * from './orgnode-to-note';

package/mappers/orgnode-to-note.d.ts

@@ -0,0 +1,3 @@
+import { OrgNode } from 'org-mode-ast';
+import { FileInfo, Note } from "../models";
+export declare function orgnodeToNote(orgnode: OrgNode, fileInfo: FileInfo): Note;

package/mappers/orgnode-to-note.js

@@ -0,0 +1,11 @@
+import { splitPath } from 'src/tools';
+export function orgnodeToNote(orgnode, fileInfo) {
+    return {
+        id: orgnode.meta.id,
+        meta: orgnode.meta,
+        filePath: splitPath(fileInfo.path),
+        touchedAt: new Date(fileInfo.atime).toISOString(),
+        updatedAt: new Date(Math.max(fileInfo.mtime, fileInfo.ctime)).toISOString(),
+        createdAt: new Date(fileInfo.ctime).toISOString(),
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.17.5",
+  "version": "0.18.0",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.js",

package/tools/__tests__/find-note-files-diff.spec.js

@@ -4,7 +4,7 @@ import { findNoteFilesDiff } from '../find-notes-files-diff';
 import { statSync } from 'fs';
 import { rmSync } from 'fs';
 import { getFileName } from '../get-file-name';
-import { join } from '../join';
+import { join } from '../join-path';
 const testFilesFolder = 'src/tools/__tests__/miscellaneous/';
 const nestedFolder = 'nested-folder/';
 const fn = (fileName) => `${testFilesFolder}${fileName}`;

package/tools/__tests__/join.spec.js

@@ -1,5 +1,5 @@
 import { test, expect } from 'vitest';
-import { join } from '../join';
+import { join } from '../join-path';
 test('Should join file paths', () => {
     const samples = [
         ['dir1', 'subdir2', 'file'],
@@ -12,3 +12,8 @@ test('Should join file paths', () => {
         expect(result).toMatchSnapshot();
     });
 });
+test('Should not take slashes from the path array into account.', () => {
+    const path = ['/', 'this', '/', 'is-path', 'qwe'];
+    const result = join(...path);
+    expect(result).toBe('this/is-path/qwe');
+});

package/tools/__tests__/split-path.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/tools/__tests__/split-path.spec.js

@@ -0,0 +1,27 @@
+import { test, expect } from 'vitest';
+import { splitPath } from 'src/tools';
+test('Should correctly split various paths with different formats', () => {
+    const pathExpected = [
+        ['/some/long/path/file.txt', ['some', 'long', 'path', 'file.txt']],
+        ['/a/b/c/d.txt', ['a', 'b', 'c', 'd.txt']],
+        ['/singlefile.txt', ['singlefile.txt']],
+        ['/folder/', ['folder']],
+        ['relative/path/to/file', ['relative', 'path', 'to', 'file']],
+        ['/leading/slash/', ['leading', 'slash']],
+        ['no/leading/slash', ['no', 'leading', 'slash']],
+        ['/trailing/slash/', ['trailing', 'slash']],
+    ];
+    pathExpected.forEach(([path, expected]) => {
+        expect(splitPath(path)).toEqual(expected);
+    });
+});
+test('Should handle edge cases like empty paths or root', () => {
+    const pathExpected = [
+        ['', []],
+        ['/', []],
+        ['//', []],
+    ];
+    pathExpected.forEach(([path, expected]) => {
+        expect(splitPath(path)).toEqual(expected);
+    });
+});

package/tools/find-notes-files-diff.js

@@ -1,6 +1,6 @@
 import { getStringPath } from './get-string-path';
 import { isOrgFile } from './is-org-file';
-import { join } from './join';
+import { join } from './join-path';
 export async function findNoteFilesDiff({ fileInfo, readDir, lastSync, storedNotesInfo, dirPath, }) {
     const orgFilePaths = await readOrgFilesRecursively({
         fileInfo,
@@ -79,7 +79,8 @@ export async function readOrgFilesRecursively({ fileInfo, readDir, dirPath, }) {
         if (!isOrgFile(f.name)) {
             continue;
         }
-        collectedPaths.push(getFullPath(f.name));
+        const fullFilePath = getFullPath(f.name);
+        collectedPaths.push(fullFilePath);
     }
     return collectedPaths;
 }

package/tools/index.d.ts

@@ -4,4 +4,5 @@ export * from './is-org-file';
 export * from './get-string-path';
 export * from './get-file-name';
 export * from './find-notes-files-diff';
-export * from './join';
+export * from './join-path';
+export * from './split-path';

package/tools/index.js

@@ -4,4 +4,5 @@ export * from './is-org-file';
 export * from './get-string-path';
 export * from './get-file-name';
 export * from './find-notes-files-diff';
-export * from './join';
+export * from './join-path';
+export * from './split-path';

package/tools/join-path.js

@@ -0,0 +1,7 @@
+export function join(...path) {
+    return path
+        .filter((p) => p !== '/')
+        .join('/')
+        .replace(/\/+/g, '/')
+        .replace(/\/+$/, '');
+}

package/tools/split-path.d.ts

@@ -0,0 +1 @@
+export declare function splitPath(path: string): string[];

package/tools/split-path.js

@@ -0,0 +1,3 @@
+export function splitPath(path) {
+    return path.split('/').filter((x) => x !== '');
+}

package/tools/join.js

@@ -1,3 +0,0 @@
-export function join(...path) {
-    return path.join('/').replace(/\/+/g, '/').replace(/\/+$/, '');
-}