orgnote-api 0.17.1 → 0.17.2

package/models/widget.ts

@@ -1,59 +0,0 @@
-import type { ChangeSpec } from '@codemirror/state';
-import { EditorView } from '@codemirror/view';
-import type { NodeType, OrgNode } from 'org-mode-ast';
-
-export type EmbeddedWidget = {
-  destroy: () => void;
-  refresh?: (...args: unknown[]) => void;
-};
-
-export interface WidgetBuilderParams {
-  wrap: HTMLElement;
-  orgNode: OrgNode;
-  rootNodeSrc: () => OrgNode;
-  onUpdateFn?: (newVal: string) => void;
-  editorView: EditorView;
-  readonly?: boolean;
-}
-
-export type WidgetBuilder = (params: WidgetBuilderParams) => EmbeddedWidget;
-
-export interface CommonEmbeddedWidget {
-  satisfied?: (orgNode: OrgNode) => boolean;
-  widgetBuilder?: WidgetBuilder;
-  viewUpdater?: (orgNode: OrgNode, newVal: string) => ViewUpdateSchema;
-  ignoreEvent?: boolean;
-  showRangeOffset?: [number, number];
-}
-
-export interface MultilineEmbeddedWidget extends CommonEmbeddedWidget {
-  widgetBuilder: WidgetBuilder;
-  suppressEdit?: boolean;
-}
-
-export type MultilineEmbeddedWidgets = {
-  [key in NodeType]?: MultilineEmbeddedWidget;
-};
-
-export type ViewUpdateSchema = ChangeSpec;
-
-export interface InlineEmbeddedWidget extends CommonEmbeddedWidget {
-  classBuilder?: (orgNode: OrgNode) => string;
-  decorationType: 'mark' | 'widget' | 'replace' | 'line';
-  ignoreEditing?: boolean;
-  side?: number;
-  wrapComponent?: string;
-  inclusive?: boolean;
-}
-
-export type InlineEmbeddedWidgets = {
-  [key in NodeType]?: InlineEmbeddedWidget;
-};
-
-export type EmbeddedWidgetBuilder = (
-  wrap: HTMLElement,
-  dynamicProps?: { [key: string]: unknown }
-) => EmbeddedWidget;
-
-export type OrgLineClass = { class: string | ((orgNode: OrgNode) => string) };
-export type OrgLineClasses = { [key in NodeType]?: OrgLineClass };

package/remote-api/.gitignore

@@ -1,4 +0,0 @@
-wwwroot/*.js
-node_modules
-typings
-dist

package/remote-api/.npmignore

@@ -1 +0,0 @@
-# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

package/remote-api/.openapi-generator/FILES

@@ -1,8 +0,0 @@
-.gitignore
-.npmignore
-api.ts
-base.ts
-common.ts
-configuration.ts
-git_push.sh
-index.ts

package/remote-api/.openapi-generator/VERSION

@@ -1 +0,0 @@
-7.7.0

package/remote-api/.openapi-generator-ignore

@@ -1,23 +0,0 @@
-# OpenAPI Generator Ignore
-# Generated by openapi-generator https://github.com/openapitools/openapi-generator
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md

package/remote-api/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/tools/__tests__/__snapshots__/join.spec.ts.snap

@@ -1,9 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Should join file paths 1`] = `"dir1/subdir2/file"`;
-
-exports[`Should join file paths 2`] = `"dir2/file"`;
-
-exports[`Should join file paths 3`] = `"/dri3/subdir2/file"`;
-
-exports[`Should join file paths 4`] = `"file"`;

package/tools/__tests__/find-files-diff.spec.ts

@@ -1,177 +0,0 @@
-import { afterEach, beforeEach, expect, test } from 'vitest';
-import { mkdirSync, rmdirSync, statSync, utimesSync, writeFileSync } from 'fs';
-import { join } from 'path';
-import { findFilesDiff } from '../find-notes-files-diff';
-import { StoredNoteInfo } from '../../models';
-
-const testFilesFolder = 'src/tools/__tests__/miscellaneous2/';
-
-function initFiles(): void {
-  mkdirSync(testFilesFolder);
-  mkdirSync(testFilesFolder + '/nested-folder');
-}
-
-function cleanFiles(): void {
-  try {
-    rmdirSync(testFilesFolder, { recursive: true });
-  } catch (e) {}
-}
-
-function createTestFile(
-  content: string,
-  fileName: string,
-  updated: Date
-): void {
-  const filePath = join(testFilesFolder, fileName);
-
-  writeFileSync(filePath, content);
-
-  const time = updated.getTime() / 1000; // Convert to seconds
-  utimesSync(filePath, time, time);
-}
-
-beforeEach(() => initFiles());
-afterEach(() => cleanFiles());
-
-test('Should find files diff', () => {
-  createTestFile(`unchanged file!`, 'org-file.org', new Date('2021-01-01'));
-  createTestFile(
-    `changed org file 2!`,
-    'org-file2.org',
-    new Date('2022-01-01')
-  );
-  createTestFile(
-    `deleted org in the nested folder file!`,
-    'nested-folder/org-file3.org',
-    new Date('2021-01-01')
-  );
-  createTestFile(
-    `created file in the nested folder!`,
-    'nested-folder/org-file4.org',
-    new Date('2021-02-01')
-  );
-
-  const storedNoteInfos: StoredNoteInfo[] = [
-    {
-      filePath: [testFilesFolder + 'deleted-org-file.org'],
-      id: 'deleted-org-file.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-    {
-      filePath: [testFilesFolder + 'org-file.org'],
-      id: 'org-file.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-    {
-      filePath: [testFilesFolder + 'org-file2.org'],
-      id: 'org-file2.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-    {
-      filePath: [testFilesFolder + 'nested-folder/org-file3.org'],
-      id: 'nested-folder/org-file3.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-  ];
-
-  const changedFiles = findFilesDiff(
-    [
-      testFilesFolder + 'org-file.org',
-      testFilesFolder + 'org-file2.org',
-      testFilesFolder + 'nested-folder/org-file3.org',
-      testFilesFolder + 'nested-folder/org-file4.org',
-    ],
-    storedNoteInfos,
-    (filePath: string) => new Date(statSync(filePath).mtime)
-  );
-
-  expect(changedFiles).toEqual({
-    created: [testFilesFolder + 'nested-folder/org-file4.org'],
-    updated: [testFilesFolder + 'org-file2.org'],
-    deleted: [testFilesFolder + 'deleted-org-file.org'],
-  });
-});
-
-test('Should find files diff when folder was renamed', () => {
-  createTestFile(
-    `nested file!`,
-    'nested-folder/org-file.org',
-    new Date('2021-01-01')
-  );
-  createTestFile(
-    `nested file2!`,
-    'nested-folder/org-file-2.org',
-    new Date('2021-01-01')
-  );
-
-  const storedNoteInfos: StoredNoteInfo[] = [
-    {
-      filePath: [testFilesFolder + 'nested-folder/org-file.org'],
-      id: 'nested-folder/org-file.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-    {
-      filePath: [testFilesFolder + 'nested-folder/org-file2.org'],
-      id: 'nested-folder/org-file2.org',
-      updatedAt: new Date('2021-01-01'),
-    },
-  ];
-
-  rmdirSync(testFilesFolder + 'nested-folder', { recursive: true });
-
-  const changedFiles = findFilesDiff(
-    [],
-    storedNoteInfos,
-    (filePath: string) => new Date(statSync(filePath).mtime)
-  );
-
-  expect(changedFiles).toMatchInlineSnapshot(`
-    {
-      "created": [],
-      "deleted": [
-        "src/tools/__tests__/miscellaneous2/nested-folder/org-file.org",
-        "src/tools/__tests__/miscellaneous2/nested-folder/org-file2.org",
-      ],
-      "updated": [],
-    }
-  `);
-});
-
-test('Should find created note when nested folder created', () => {
-  mkdirSync(testFilesFolder + 'new-nested-folder');
-  createTestFile(
-    `new nested file!`,
-    'new-nested-folder/org-file.org',
-    new Date('2023-01-01')
-  );
-
-  const storedNoteInfos: StoredNoteInfo[] = [];
-
-  const changedFiles = findFilesDiff(
-    [testFilesFolder + 'new-nested-folder/org-file.org'],
-    storedNoteInfos,
-    (filePath: string) => new Date(statSync(filePath).mtime)
-  );
-
-  expect(changedFiles).toEqual({
-    created: [testFilesFolder + 'new-nested-folder/org-file.org'],
-    updated: [],
-    deleted: [],
-  });
-});
-
-test('Should find nothing when no files provided', () => {
-  const storedNoteInfos: StoredNoteInfo[] = [];
-
-  const changedFiles = findFilesDiff(
-    [],
-    storedNoteInfos,
-    (filePath: string) => new Date(statSync(filePath).mtime)
-  );
-
-  expect(changedFiles).toEqual({
-    created: [],
-    updated: [],
-    deleted: [],
-  });
-});

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

@@ -1,207 +0,0 @@
-import { mkdirSync, writeFileSync, utimesSync, readdirSync } from 'fs';
-import { afterEach, beforeEach, test, expect } from 'vitest';
-import { FileInfo, StoredNoteInfo } from '../../models';
-import { findNoteFilesDiff } from '../find-notes-files-diff';
-import { statSync } from 'fs';
-import { Stats } from 'fs';
-import { rmSync } from 'fs';
-import { getFileName } from '../get-file-name';
-import { join } from '../join';
-
-const testFilesFolder = 'src/tools/__tests__/miscellaneous/';
-const nestedFolder = 'nested-folder/';
-const fn = (fileName: string) => `${testFilesFolder}${fileName}`;
-const fns = (fileName: string) =>
-  `${testFilesFolder}${nestedFolder}${fileName}`;
-
-function initFiles(): void {
-  mkdirSync(testFilesFolder.slice(0, -1));
-  mkdirSync(fn(nestedFolder));
-}
-
-function cleanFiles(): void {
-  try {
-    rmSync(testFilesFolder, { recursive: true });
-  } catch (e) {}
-}
-
-function createTestFile(
-  filePath: string,
-  updated: Date,
-  content: string
-): void {
-  writeFileSync(filePath, content);
-
-  const time = updated.getTime() / 1000; // Convert to seconds
-  utimesSync(filePath, time, time);
-}
-
-beforeEach(() => initFiles());
-afterEach(() => cleanFiles());
-
-const fileStatToFileInfo = (path: string, stat: Stats): FileInfo => ({
-  path,
-  name: getFileName(path),
-  type: stat.isFile() ? 'file' : 'directory',
-  size: stat.size,
-  atime: stat.atime.getTime(),
-  mtime: stat.mtime.getTime(),
-  ctime: stat.ctime.getTime(),
-});
-
-test('Should sync notes files', async () => {
-  const files = [
-    [fn('file-1.org')],
-    [fn('file-2.org')],
-    [fn('file-9.org'), new Date('2024-10-10')],
-    [fns('file-3.org')],
-    [fns('file-4.org'), new Date('2024-08-09')],
-  ] as const;
-
-  files.forEach(([f, d], i) =>
-    createTestFile(
-      f,
-      d ?? new Date('2024-01-01'),
-      `:PROPERTIES:
-:ID: ${i + 1}
-:PROPERTIES:
-
-* Hello world from note:
-- ${f}`
-    )
-  );
-
-  const storedNotesInfo: StoredNoteInfo[] = [
-    {
-      id: '2',
-      filePath: fn('file-1.org').split('/'),
-      updatedAt: new Date('2024-01-01'),
-    },
-    {
-      id: '3',
-      filePath: fns('file-3.org').split('/'),
-      updatedAt: new Date('2024-01-01'),
-    },
-    {
-      id: '9',
-      filePath: fn('file-9.org').split('/'),
-      updatedAt: new Date('2020-01-01'),
-    },
-    {
-      id: '10',
-      filePath: fns('file-10.org').split('/'),
-      updatedAt: new Date('2020-01-01'),
-    },
-  ];
-
-  const notesFilesDiff = await findNoteFilesDiff({
-    fileInfo: async (path: string) => {
-      const stats = statSync(path);
-
-      const fileInfo: FileInfo = fileStatToFileInfo(path, stats);
-
-      return Promise.resolve(fileInfo);
-    },
-    readDir: async (path: string) => {
-      const dirents = readdirSync(path, { withFileTypes: true });
-
-      const fileInfos: FileInfo[] = dirents.map((dirent) => {
-        const stats = statSync(join(path, dirent.name));
-        const fileInfo = fileStatToFileInfo(join(path, dirent.name), stats);
-        return fileInfo;
-      });
-
-      return Promise.resolve(fileInfos);
-    },
-    storedNotesInfo,
-    dirPath: testFilesFolder,
-  });
-
-  expect(notesFilesDiff).toMatchInlineSnapshot(`
-    {
-      "created": [
-        {
-          "filePath": "src/tools/__tests__/miscellaneous/file-2.org",
-        },
-        {
-          "filePath": "src/tools/__tests__/miscellaneous/nested-folder/file-4.org",
-        },
-      ],
-      "deleted": [
-        {
-          "filePath": "src/tools/__tests__/miscellaneous/nested-folder/file-10.org",
-          "id": "10",
-        },
-      ],
-      "updated": [
-        {
-          "filePath": "src/tools/__tests__/miscellaneous/file-9.org",
-        },
-      ],
-    }
-  `);
-});
-
-test('Should detect no changes when all files match stored info', async () => {
-  const files = [
-    [fn('file-1.org'), new Date('2024-01-01')],
-    [fn('file-2.org'), new Date('2024-01-01')],
-    [fns('file-3.org'), new Date('2024-01-01')],
-  ] as const;
-
-  files.forEach(([f, d], i) =>
-    createTestFile(
-      f,
-      d ?? new Date('2024-01-01'),
-      `:PROPERTIES:
-:ID: ${i + 1}
-:PROPERTIES:
-
-* Note:
-- ${f}`
-    )
-  );
-
-  const storedNotesInfo: StoredNoteInfo[] = [
-    {
-      id: '1',
-      filePath: fn('file-1.org').split('/'),
-      updatedAt: new Date('2024-01-01'),
-    },
-    {
-      id: '2',
-      filePath: fn('file-2.org').split('/'),
-      updatedAt: new Date('2024-01-01'),
-    },
-    {
-      id: '3',
-      filePath: fns('file-3.org').split('/'),
-      updatedAt: new Date('2024-01-01'),
-    },
-  ];
-
-  const notesFilesDiff = await findNoteFilesDiff({
-    fileInfo: async (path: string) => {
-      const stats = statSync(path);
-      const fileInfo: FileInfo = fileStatToFileInfo(path, stats);
-      return Promise.resolve(fileInfo);
-    },
-    readDir: async (path: string) => {
-      const dirents = readdirSync(path, { withFileTypes: true });
-      const fileInfos: FileInfo[] = dirents.map((dirent) => {
-        const stats = statSync(join(path, dirent.name));
-        const fileInfo = fileStatToFileInfo(join(path, dirent.name), stats);
-        return fileInfo;
-      });
-      return Promise.resolve(fileInfos);
-    },
-    storedNotesInfo,
-    dirPath: testFilesFolder,
-  });
-
-  expect(notesFilesDiff).toEqual({
-    created: [],
-    updated: [],
-    deleted: [],
-  });
-});

package/tools/__tests__/get-string-path.spec.ts

@@ -1,32 +0,0 @@
-import { getStringPath } from '../get-string-path';
-import { test, expect } from 'vitest';
-
-test('should return the same string if path is a string', () => {
-  const path = 'some/path';
-  const result = getStringPath(path);
-  expect(result).toBe('some/path');
-});
-
-test('should join array elements with "/" if path is an array', () => {
-  const path = ['some', 'path'];
-  const result = getStringPath(path);
-  expect(result).toBe('some/path');
-});
-
-test('should return an empty string if path is an empty array', () => {
-  const path: string[] = [];
-  const result = getStringPath(path);
-  expect(result).toBe('');
-});
-
-test('should handle array with one element correctly', () => {
-  const path = ['single'];
-  const result = getStringPath(path);
-  expect(result).toBe('single');
-});
-
-test('should handle array with multiple elements correctly', () => {
-  const path = ['this', 'is', 'a', 'test'];
-  const result = getStringPath(path);
-  expect(result).toBe('this/is/a/test');
-});

package/tools/__tests__/is-org-file.spec.ts

@@ -1,62 +0,0 @@
-import { test, expect } from 'vitest';
-import { isOrgFile, isOrgGpgFile } from '../is-org-file';
-
-test('Should return true for org files', () => {
-  const files = [
-    'myNote.org',
-    'my_note.org',
-    '123.org',
-    'some_long_note#4123$123eqasdasd.org.gpg',
-    'some_long_note#4123$123eqasdasd.org',
-    'note with space.org',
-    'note with space.org.gpg',
-  ];
-
-  files.forEach((file) => {
-    expect(isOrgFile(file), file).toBe(true);
-  });
-});
-
-test('Should not return true for non-org files', () => {
-  const files = [
-    'myNote.md',
-    'my_note.md',
-    '123.md',
-    'some_long_note#4123$123eqasdas',
-    'note.org.file',
-    'org',
-    'org.',
-    'text.gpg',
-  ];
-
-  files.forEach((file) => {
-    expect(isOrgFile(file), file).toBe(false);
-  });
-});
-
-test('Should return true for org.gpg files', () => {
-  const gpgFiles = [
-    'myNote.org.gpg',
-    'my_note.org.gpg',
-    '123.org.gpg',
-    'org.org.gpg',
-    'gp_org.org.gpg',
-  ];
-
-  gpgFiles.forEach((file) => {
-    expect(isOrgGpgFile(file), file).toBe(true);
-  });
-});
-
-test('Should not return true for not .org.gpg files', () => {
-  const notGpgFiles = [
-    'myNote.org',
-    'my_note.org',
-    '123.org',
-    'some_gpg_file.txt',
-  ];
-
-  notGpgFiles.forEach((file) => {
-    expect(isOrgGpgFile(file), file).toBe(false);
-  });
-});

package/tools/__tests__/join.spec.ts

@@ -1,16 +0,0 @@
-import { test, expect } from 'vitest';
-import { join } from '../join';
-
-test('Should join file paths', () => {
-  const samples = [
-    ['dir1', 'subdir2', 'file'],
-    ['dir2/', '/file'],
-    ['/dri3', 'subdir2/', 'file'],
-    ['file'],
-  ];
-
-  samples.forEach((sample) => {
-    const result = join(...sample);
-    expect(result).toMatchSnapshot();
-  });
-});