alikia2x/OpenRewind
1
1
Fork 0
Code Issues Releases 1 Activity

ref: format

Browse Source
This commit is contained in:
alikia2x (寒寒) 2024-12-29 22:35:25 +08:00
parent bc0483cdc8
commit d2899d4b50
Signed by: alikia2x
GPG Key ID: 56209E0CCD8420C6
48 changed files with 600 additions and 568 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.prettierrc
View File

@ -1,8 +1,8 @@
{
"useTabs": true,
"tabWidth": 4,
"trailingComma": "none",
"singleQuote": false,
"printWidth": 100,
"endOfLine": "lf"
"useTabs": true,
"tabWidth": 4,
"trailingComma": "none",
"singleQuote": false,
"printWidth": 100,
"endOfLine": "lf"
}

12
README.md
View File

@ -9,11 +9,11 @@ to rewind.ai, and that app is **OpenRewind**.
### Update the OCR Engine
OpenRecall currently uses docTR as its OCR engine, but it performs inadequately.
On my MacBook Air M2 (2022), processing a screenshot takes around 20 seconds, with CPU usage peaking at over 400%.
OpenRecall currently uses docTR as its OCR engine, but it performs inadequately.
On my MacBook Air M2 (2022), processing a screenshot takes around 20 seconds, with CPU usage peaking at over 400%.
During this time, screenshots cannot be captured, and the engine appears to recognize only Latin characters.
To address this, we plan to replace the OCR with a more efficient alternative that supports multiple writing systems.
To address this, we plan to replace the OCR with a more efficient alternative that supports multiple writing systems.
We are working on [RapidOCR ONNX](https://github.com/alikia2x/RapidOCR-ONNX), a fork of a project which has same name,
developed by RapidAI.
RapidOCR ONNX uses [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) as its model architecture, and
@ -21,17 +21,17 @@ runs on the [ONNX Runtime](https://github.com/microsoft/onnxruntime/).
### Implement a Task Queue/Scheduler
Currently, OpenRecall's OCR recognition and database operations are synchronous (blocking).
Currently, OpenRecall's OCR recognition and database operations are synchronous (blocking).
This results in increased screenshot frequency, as described in the previous section.
Our next goal is to introduce a task queue to handle high-load tasks (such as OCR, indexing, and archiving) asynchronously. This will ensure that time-sensitive tasks (like capturing screenshots) are prioritized.
### Improve the Frontend
The current frontend of OpenRecall is quite basic. Given my expertise in web development,
The current frontend of OpenRecall is quite basic. Given my expertise in web development,
I will build a more elegant frontend from scratch.
We are now switched to Electron in order to deliver a native experience,
We are now switched to Electron in order to deliver a native experience,
aiming to match the functionality of [rewind.ai](https://rewind.ai).
### Add More Features

20
components/settings/IconWithText.tsx
View File

@ -7,14 +7,22 @@ export default function IconWithText() {
const { t } = useTranslation();
return (
<div className="flex">
<img src={imgUrl} className="h-20 w-20 mr-2" alt="OpenRewind icon"/>
<img src={imgUrl} className="h-20 w-20 mr-2" alt="OpenRewind icon" />
<div className="flex flex-col justify-start w-auto h-[4.2rem] overflow-hidden mt-1">
<span className="text-2xl font-semibold">OpenRewind</span>
<span className="text-sm text-gray-700 dark:text-gray-200
font-medium ml-0.5">{t("settings.version", { version: pjson.version })}</span>
<span className="text-xs text-gray-700 dark:text-gray-200
font-medium ml-0.5">{t("settings.copyright")}</span>
<span
className="text-sm text-gray-700 dark:text-gray-200
font-medium ml-0.5"
>
{t("settings.version", { version: pjson.version })}
</span>
<span
className="text-xs text-gray-700 dark:text-gray-200
font-medium ml-0.5"
>
{t("settings.copyright")}
</span>
</div>
</div>
);
}
}

14
components/settings/MenuItem.tsx
View File

@ -1,10 +1,14 @@
import { MouseEventHandler } from "react";
import { Icon } from "@iconify-icon/react";
const MenuItem = ({ icon, text, onClick }: {
icon: string,
text: string,
onClick: MouseEventHandler<HTMLDivElement>
const MenuItem = ({
icon,
text,
onClick
}: {
icon: string;
text: string;
onClick: MouseEventHandler<HTMLDivElement>;
}) => {
return (
<div
@ -20,4 +24,4 @@ const MenuItem = ({ icon, text, onClick }: {
);
};
export default MenuItem;
export default MenuItem;

8
components/settings/OpenSourceNote.tsx
View File

@ -7,10 +7,8 @@ export default function OpenSourceNote() {
OpenRewind is open source software licensed under
<a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL 3.0</a>.<br />
Source code is avaliable at
<a href="https://github.com/alikia2x/openrewind">
GitHub
</a>.
<a href="https://github.com/alikia2x/openrewind">GitHub</a>.
</Trans>
</p>
)
}
);
}

14
components/settings/SettingsGroup.tsx
View File

@ -1,9 +1,15 @@
import * as React from "react";
import { useRef } from "react";
const SettingsGroup = (
{ children, groupName, addGroupRef }:
{ children: React.ReactNode, groupName: string, addGroupRef: Function }) => {
const SettingsGroup = ({
children,
groupName,
addGroupRef
}: {
children: React.ReactNode;
groupName: string;
addGroupRef: Function;
}) => {
const groupRef = useRef(null);
React.useEffect(() => {
@ -17,4 +23,4 @@ const SettingsGroup = (
);
};
export default SettingsGroup;
export default SettingsGroup;

8
components/settings/Title.tsx
View File

@ -2,9 +2,7 @@ import { useTranslation } from "react-i18next";
const Title = ({ i18nKey }: { i18nKey: string }) => {
const { t } = useTranslation();
return (
<h1 className="text-3xl font-bold leading-[3rem]">{t(i18nKey)}</h1>
);
}
return <h1 className="text-3xl font-bold leading-[3rem]">{t(i18nKey)}</h1>;
};
export default Title;
export default Title;

89
docs/database-changelog.md
View File

@ -1,6 +1,6 @@
# Database Schema Changelog
This document outlines the changes made across different versions of
This document outlines the changes made across different versions of
database structure used in the OpenRewind, including tables and fields.
## Version 3 Schema Changes
@ -22,11 +22,14 @@ ALTER TABLE encoding_task RENAME COLUMN createAt TO createdAt;
The `createdAt` column was updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE encoding_task SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
```
@ -45,11 +48,14 @@ ALTER TABLE frame RENAME COLUMN createAt TO createdAt;
The `createdAt` column was updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE frame SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
updateStmt.run(unixTimestamp, row.id);
});
```
@ -69,12 +75,15 @@ ALTER TABLE segments RENAME COLUMN endAt TO endedAt;
The `startedAt` and `endedAt` columns were updated to store Unix timestamps instead of formatted timestamps.
```typescript
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStart = db.prepare(`UPDATE segments SET startedAt_new = ? WHERE id = ?`);
const updateEnd = db.prepare(`UPDATE segments SET endedAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
updateStart.run(convertTimestampToUnix(row.startedAt as string), row.id);
updateEnd.run(convertTimestampToUnix(row.endedAt as string), row.id);
updateStart.run(convertTimestampToUnix(row.startedAt as string), row.id);
updateEnd.run(convertTimestampToUnix(row.endedAt as string), row.id);
});
```
@ -89,15 +98,15 @@ ALTER TABLE frame DROP COLUMN encoded;
### Summary of Changes
- **Update `encoding_task` Table:**
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- **Update `frame` Table:**
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- Dropped the deprecated `encoded` column.
- Renamed `createAt` to `createdAt`.
- Converted `createdAt` to store Unix timestamps.
- Dropped the deprecated `encoded` column.
- **Update `segments` Table:**
- Renamed `startAt` and `endAt` to `startedAt` and `endedAt` respectively.
- Converted `startedAt` and `endedAt` to store Unix timestamps.
- Renamed `startAt` and `endAt` to `startedAt` and `endedAt` respectively.
- Converted `startedAt` and `endedAt` to store Unix timestamps.
## Version 2 Schema
@ -107,10 +116,10 @@ Corresponding version: 0.4.0
Stores configuration data, including the database version.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|---------------------|-----------------------------------------------------------------------------|
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | -------------------------------------- |
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
#### Insert Default Version
@ -123,7 +132,7 @@ INSERT INTO config (key, value) VALUES ('version', '2');
Stores encoding tasks that are queued for processing.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|----------------------------|--------------------------------------|
| ----------- | --------- | -------------------------- | ------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique ID for the task. |
| `createAt` | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP | Timestamp when the task was created. |
| `status` | INTEGER | DEFAULT 0 | Indicates the status of the task. |
@ -132,8 +141,8 @@ Stores encoding tasks that are queued for processing.
- `0`: Pending
- `1`: In Progress
- `2`: Completed
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
- `2`: Completed
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
### New Trigger: `delete_encoding_task`
@ -158,11 +167,10 @@ END;
Stores the frames that need to be encoded for the encoding task
| Column Name | Data Type | Constraints/Default | Description |
|------------------|-----------|-------------------------------------|------------------------------------------------------|
| ---------------- | --------- | ----------------------------------- | ---------------------------------------------------- |
| `frame` | INTEGER | PRIMARY KEY, FOREIGN KEY (frame.id) | ID for the frame associated with the encoding task. |
| `encodingTaskID` | TIMESTAMP | FOREIGN KEY (encoding_task.id) | ID for the encoding task associated with this frame. |
### Update `frame` Table
#### Simplify `imgFilename`
@ -170,12 +178,12 @@ Stores the frames that need to be encoded for the encoding task
The `imgFilename` column was updated to store only the filename without the full path.
```typescript
const rows = db.prepare('SELECT id, imgFilename FROM frame').all() as OldFrame[];
rows.forEach(row => {
const filename = row.imgFilename.match(/[^\\/]+$/)?.[0];
if (filename) {
db.prepare('UPDATE frame SET imgFilename = ? WHERE id = ?').run(filename, row.id);
}
const rows = db.prepare("SELECT id, imgFilename FROM frame").all() as OldFrame[];
rows.forEach((row) => {
const filename = row.imgFilename.match(/[^\\/]+$/)?.[0];
if (filename) {
db.prepare("UPDATE frame SET imgFilename = ? WHERE id = ?").run(filename, row.id);
}
});
```
@ -192,12 +200,11 @@ UPDATE frame SET encodeStatus = CASE WHEN encoded THEN 2 ELSE 0 END;
- **New Table:** `config` to store configuration data.
- **Update `frame` Table:**
- Simplified `imgFilename` to store only the filename.
- Added `encodeStatus` column to replace the deprecated `encoded` column.
- Simplified `imgFilename` to store only the filename.
- Added `encodeStatus` column to replace the deprecated `encoded` column.
- **Deprecated `encoded` column.**
- The `encoded` column is no longer used and is retained due to SQLite's inability to drop columns.
Creating a new table without this column and copying data to the new table could be time-consuming.
- The `encoded` column is no longer used and is retained due to SQLite's inability to drop columns.
Creating a new table without this column and copying data to the new table could be time-consuming.
## Version 1 Schema
@ -208,7 +215,7 @@ Corresponding version: 0.3.x
Stores information about individual frames.
| Column Name | Data Type | Constraints/Default | Description |
|-------------------|-----------|---------------------------------|-------------------------------------------------------------------------|
| ----------------- | --------- | ------------------------------- | ----------------------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each frame. |
| `createAt` | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP | Timestamp when the frame was created. |
| `imgFilename` | TEXT | | Filename of the image associated with the frame. |
@ -223,7 +230,7 @@ Stores information about individual frames.
Stores recognition data associated with frames.
| Column Name | Data Type | Constraints/Default | Desc[database-structure.md](database-structure.md)ription |
|-------------|-----------|----------------------------|-----------------------------------------------------------|
| ----------- | --------- | -------------------------- | --------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each recognition data entry. |
| `frameID` | INTEGER | FOREIGN KEY (frame.id) | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
@ -236,7 +243,7 @@ While capturing the screen, OpenRewind retrieves the currently active window.
When it finds that the currently active window has changed to another application, a new segment will start.
| Column Name | Data Type | Constraints/Default | Description |
|---------------|-----------|----------------------------|------------------------------------------------------|
| ------------- | --------- | -------------------------- | ---------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each segment. |
| `startAt` | TIMESTAMP | | Timestamp when the segment starts. |
| `endAt` | TIMESTAMP | | Timestamp when the segment ends. |
@ -253,7 +260,7 @@ When it finds that the currently active window has changed to another applicatio
Used for full-text search on recognition data.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|---------------------|--------------------------------------------------------|
| ----------- | --------- | ------------------- | ------------------------------------------------------ |
| `id` | INTEGER | UNINDEXED | ID of the recognition data entry. |
| `frameID` | INTEGER | UNINDEXED | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |

34
docs/database-structure.md
View File

@ -6,10 +6,10 @@ This document outlines the current structure of the database schema used in the
Stores configuration data.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|---------------------|-----------------------------------------------------------------------------|
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | ------------------- | -------------------------------------- |
| `key` | TEXT | PRIMARY KEY | Unique key for configuration settings. |
| `value` | TEXT | | Value associated with the key. |
### Key: version
@ -20,7 +20,7 @@ The current database schema version, represented as an integer. Since the `confi
Stores information about individual frames.
| Column Name | Data Type | Constraints/Default | Description |
|-------------------|-----------|---------------------------------|-----------------------------------------------------------|
| ----------------- | --------- | ------------------------------- | --------------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each frame. |
| `createdAt` | REAL | | Timestamp when the frame was created. |
| `imgFilename` | TEXT | | Filename of the image associated with the frame. |
@ -40,19 +40,19 @@ Stores information about individual frames.
Stores recognition data associated with frames.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|------------------------------|-----------------------------------------------------------------------------|
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each recognition data entry. |
| `frameID` | INTEGER | FOREIGN KEY (frame.id) | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
| Column Name | Data Type | Constraints/Default | Description |
| ----------- | --------- | -------------------------- | ------------------------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each recognition data entry. |
| `frameID` | INTEGER | FOREIGN KEY (frame.id) | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
| `text` | TEXT | | Recognized text. |
## Table: `segments`
A segment is a period of time when a user uses a particular application. While capturing the screen, OpenRewind detects the currently active window. When it finds that the currently active window has changed to another application, a new segment will start.
| Column Name | Data Type | Constraints/Default | Description |
|---------------|-----------|----------------------------|------------------------------------------------------|
| ------------- | --------- | -------------------------- | ---------------------------------------------------- |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique identifier for each segment. |
| `startedAt` | REAL | | Timestamp when the segment starts. |
| `endedAt` | REAL | | Timestamp when the segment ends. |
@ -69,7 +69,7 @@ A segment is a period of time when a user uses a particular application. While c
Stores encoding tasks that are queued for processing.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|----------------------------|--------------------------------------|
| ----------- | --------- | -------------------------- | ------------------------------------ |
| `id` | INTEGER | PRIMARY KEY, AUTOINCREMENT | Unique ID for the task. |
| `createdAt` | REAL | | Timestamp when the task was created. |
| `status` | INTEGER | DEFAULT 0 | Indicates the status of the task. |
@ -79,14 +79,14 @@ Stores encoding tasks that are queued for processing.
- `0`: Pending
- `1`: In Progress
- `2`: Completed
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
- Once the task was set to this status, it will be imminently deleted by a trigger mentioned below.
## Table: `encoding_task_data`
Stores the frames that need to be encoded for the encoding task.
| Column Name | Data Type | Constraints/Default | Description |
|------------------|-----------|-------------------------------------|------------------------------------------------------|
| ---------------- | --------- | ----------------------------------- | ---------------------------------------------------- |
| `encodingTaskID` | INTEGER | FOREIGN KEY (encoding_task.id) | ID for the encoding task associated with this frame. |
| `frame` | INTEGER | PRIMARY KEY, FOREIGN KEY (frame.id) | ID for the frame associated with the encoding task. |
@ -95,7 +95,7 @@ Stores the frames that need to be encoded for the encoding task.
Used for full-text search on recognition data.
| Column Name | Data Type | Constraints/Default | Description |
|-------------|-----------|---------------------|--------------------------------------------------------|
| ----------- | --------- | ------------------- | ------------------------------------------------------ |
| `id` | INTEGER | UNINDEXED | ID of the recognition data entry. |
| `frameID` | INTEGER | UNINDEXED | ID of the frame to which the recognition data belongs. |
| `data` | TEXT | | Raw recognition data. |
@ -154,4 +154,4 @@ BEGIN
DELETE FROM encoding_task
WHERE id = OLD.id AND NEW.status = 2;
END;
```
```

58
electron-builder.json
View File

@ -1,32 +1,28 @@
{
"appId": "com.alikia2x.openrewind",
"mac": {
"category": "public.app-category.productivity",
"target": "dmg",
"files": [
"bin/macos"
]
},
"productName": "OpenRewind",
"directories": {
"output": "dist/release"
},
"files": [
"dist/electron/**/*",
"dist/electron/assets/*",
"dist/electron/i18n/*",
"dist/renderer/**/*",
"dist/renderer/assets/*"
],
"win": {
"target": "nsis",
"files": [
"bin/win32"
]
},
"linux": {
"target": "AppImage"
},
"copyright": "Copyright © 2024 alikia2x",
"asar": false
}
"appId": "com.alikia2x.openrewind",
"mac": {
"category": "public.app-category.productivity",
"target": "dmg",
"files": ["bin/macos"]
},
"productName": "OpenRewind",
"directories": {
"output": "dist/release"
},
"files": [
"dist/electron/**/*",
"dist/electron/assets/*",
"dist/electron/i18n/*",
"dist/renderer/**/*",
"dist/renderer/assets/*"
],
"win": {
"target": "nsis",
"files": ["bin/win32"]
},
"linux": {
"target": "AppImage"
},
"copyright": "Copyright © 2024 alikia2x",
"asar": false
}

41
gulpfile.ts
View File

@ -4,42 +4,37 @@ import ts from "gulp-typescript";
import clean from "gulp-clean";
import fs from "fs";
const tsProject = ts.createProject('tsconfig.json');
const tsProject = ts.createProject("tsconfig.json");
gulp.task('clean', function () {
return gulp.src('dist/electron', {read: false, allowEmpty: true})
.pipe(clean());
gulp.task("clean", function () {
return gulp.src("dist/electron", { read: false, allowEmpty: true }).pipe(clean());
});
gulp.task('scripts', () => {
gulp.task("scripts", () => {
if (!fs.existsSync("dist/electron")) {
fs.mkdirSync("dist/electron", { recursive: true });
}
const tsResult = tsProject.src()
.pipe(tsProject());
const tsResult = tsProject.src().pipe(tsProject());
const jsFiles = gulp.src(['src/electron/**/*.js', 'src/electron/**/*.cjs']);
const jsFiles = gulp.src(["src/electron/**/*.js", "src/electron/**/*.cjs"]);
return tsResult.js
.pipe(gulp.dest('dist/electron'))
.on('end', () => {
jsFiles.pipe(gulp.dest('dist/electron'));
});
return tsResult.js.pipe(gulp.dest("dist/electron")).on("end", () => {
jsFiles.pipe(gulp.dest("dist/electron"));
});
});
gulp.task('assets', () => {
return gulp.src('src/electron/assets/**/*', { encoding: false })
.pipe(gulp.dest('dist/electron/assets'));
gulp.task("assets", () => {
return gulp
.src("src/electron/assets/**/*", { encoding: false })
.pipe(gulp.dest("dist/electron/assets"));
});
gulp.task('binary', () => {
return gulp.src('bin/**/*', { encoding: false })
.pipe(gulp.dest('dist/electron/bin'));
gulp.task("binary", () => {
return gulp.src("bin/**/*", { encoding: false }).pipe(gulp.dest("dist/electron/bin"));
});
gulp.task("locales", () => {
return gulp.src('i18n/**/*')
.pipe(gulp.dest('dist/electron/i18n'));
})
return gulp.src("i18n/**/*").pipe(gulp.dest("dist/electron/i18n"));
});
gulp.task('build', gulp.series('clean', 'scripts', 'assets', 'binary', 'locales'));
gulp.task("build", gulp.series("clean", "scripts", "assets", "binary", "locales"));

12
i18n/ar.json
View File

@ -1,8 +1,8 @@
{
"settings": "إعدادات",
"tray": {
"quit": "يترك",
"showMainWindow": "يبحث",
"showSettingsWindow": "إعدادات"
}
"settings": "إعدادات",
"tray": {
"quit": "يترك",
"showMainWindow": "يبحث",
"showSettingsWindow": "إعدادات"
}
}

12
i18n/de.json
View File

@ -1,8 +1,8 @@
{
"settings": "Einstellungen",
"tray": {
"quit": "Aufhören",
"showMainWindow": "Suchen",
"showSettingsWindow": "Einstellungen"
}
"settings": "Einstellungen",
"tray": {
"quit": "Aufhören",
"showMainWindow": "Suchen",
"showSettingsWindow": "Einstellungen"
}
}

40
i18n/en.json
View File

@ -1,22 +1,22 @@
{
"settings": {
"title": "Settings",
"about": "About",
"screen": "Screen",
"screen-recording": "Screen Recording",
"version": "Version {version}",
"copyright": "Copyright © 2024 alikia2x",
"note": "OpenRewind is an open source software licensed under <1>GPL 3.0</1>, <3></3>and its source code is avaliable at <5>GitHub</5>.",
"environment-details": "Environment Info",
"node-version": "Node.js Version",
"electron-version": "Electron Version",
"chrome-version": "Chrome Version",
"os-version": "OS Version",
"os": "Operating System"
},
"tray": {
"showMainWindow": "Search",
"showSettingsWindow": "Settings",
"quit": "Quit"
}
"settings": {
"title": "Settings",
"about": "About",
"screen": "Screen",
"screen-recording": "Screen Recording",
"version": "Version {version}",
"copyright": "Copyright © 2024 alikia2x",
"note": "OpenRewind is an open source software licensed under <1>GPL 3.0</1>, <3></3>and its source code is avaliable at <5>GitHub</5>.",
"environment-details": "Environment Info",
"node-version": "Node.js Version",
"electron-version": "Electron Version",
"chrome-version": "Chrome Version",
"os-version": "OS Version",
"os": "Operating System"
},
"tray": {
"showMainWindow": "Search",
"showSettingsWindow": "Settings",
"quit": "Quit"
}
}

12
i18n/es.json
View File

@ -1,8 +1,8 @@
{
"settings": "Ajustes",
"tray": {
"quit": "Abandonar",
"showMainWindow": "Buscar",
"showSettingsWindow": "Ajustes"
}
"settings": "Ajustes",
"tray": {
"quit": "Abandonar",
"showMainWindow": "Buscar",
"showSettingsWindow": "Ajustes"
}
}

12
i18n/fr.json
View File

@ -1,8 +1,8 @@
{
"settings": "Paramètres",
"tray": {
"quit": "Quitter",
"showMainWindow": "Recherche",
"showSettingsWindow": "Paramètres"
}
"settings": "Paramètres",
"tray": {
"quit": "Quitter",
"showMainWindow": "Recherche",
"showSettingsWindow": "Paramètres"
}
}

12
i18n/it.json
View File

@ -1,8 +1,8 @@
{
"settings": "Impostazioni",
"tray": {
"quit": "Esentato",
"showMainWindow": "Ricerca",
"showSettingsWindow": "Impostazioni"
}
"settings": "Impostazioni",
"tray": {
"quit": "Esentato",
"showMainWindow": "Ricerca",
"showSettingsWindow": "Impostazioni"
}
}

12
i18n/ja.json
View File

@ -1,8 +1,8 @@
{
"settings": "設定",
"tray": {
"quit": "やめる",
"showMainWindow": "検索",
"showSettingsWindow": "設定"
}
"settings": "設定",
"tray": {
"quit": "やめる",
"showMainWindow": "検索",
"showSettingsWindow": "設定"
}
}

12
i18n/ko.json
View File

@ -1,8 +1,8 @@
{
"settings": "설정",
"tray": {
"quit": "그만두다",
"showMainWindow": "찾다",
"showSettingsWindow": "설정"
}
"settings": "설정",
"tray": {
"quit": "그만두다",
"showMainWindow": "찾다",
"showSettingsWindow": "설정"
}
}

40
i18n/zh-CN.json
View File

@ -1,22 +1,22 @@
{
"settings": {
"title": "设置",
"about": "关于",
"screen": "屏幕",
"screen-recording": "屏幕录制",
"version": "版本 {version}",
"copyright": "版权所有 © 2024 alikia2x",
"note": "OpenRewind 是基于<1>GPL 3.0</1>授权的开源软件， <3></3>其源代码托管在<5>GitHub</5>上。",
"environment-details": "运行环境",
"node-version": "Node.js 版本",
"electron-version": "Electron 版本",
"chrome-version": "Chrome 版本",
"os-version": "系统版本",
"os": "操作系统"
},
"tray": {
"showMainWindow": "搜索…",
"showSettingsWindow": "应用设置",
"quit": "退出 OpenRewind"
}
"settings": {
"title": "设置",
"about": "关于",
"screen": "屏幕",
"screen-recording": "屏幕录制",
"version": "版本 {version}",
"copyright": "版权所有 © 2024 alikia2x",
"note": "OpenRewind 是基于<1>GPL 3.0</1>授权的开源软件， <3></3>其源代码托管在<5>GitHub</5>上。",
"environment-details": "运行环境",
"node-version": "Node.js 版本",
"electron-version": "Electron 版本",
"chrome-version": "Chrome 版本",
"os-version": "系统版本",
"os": "操作系统"
},
"tray": {
"showMainWindow": "搜索…",
"showSettingsWindow": "应用设置",
"quit": "退出 OpenRewind"
}
}

165
package.json
View File

@ -1,84 +1,85 @@
{
"name": "openrewind",
"version": "0.6.0",
"type": "module",
"description": "Your second brain, superpowered.",
"main": "dist/electron/index.js",
"scripts": {
"dev": "cross-env NODE_ENV=dev bun run dev:all",
"dev:all": "concurrently -n=react,electron -c='#ff3e00',blue \"bun run dev:react\" \"bun run dev:electron\"",
"dev:react": "vite dev",
"dev:electron": "bunx gulp build && electron dist/electron/index.js",
"build:react": "vite build",
"build:app": "bunx gulp build",
"build:electron": "electron-builder"
},
"keywords": [],
"author": "",
"license": "MIT",
"dependencies": {
"@alikia/random-key": "npm:@jsr/alikia__random-key",
"@electron/remote": "^2.1.2",
"@hono/node-server": "^1.13.7",
"@unly/universal-language-detector": "^2.0.3",
"better-sqlite3": "^11.6.0",
"detect-port": "^2.1.0",
"electron-context-menu": "^4.0.4",
"electron-reloader": "^1.2.3",
"electron-screencapture": "^1.1.0",
"electron-serve": "^2.1.1",
"electron-store": "^10.0.0",
"electron-window-state": "^5.0.3",
"execa": "^9.5.1",
"hono": "^4.6.15",
"i18next": "^24.0.2",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-electron-fs-backend": "^3.0.2",
"i18next-fs-backend": "^2.6.0",
"i18next-icu": "^2.3.0",
"image-size": "^1.1.1",
"memory-cache": "^0.2.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-i18next": "^15.1.2",
"react-router": "^7.0.1",
"react-router-dom": "^7.0.1",
"screenshot-desktop": "^1.15.0",
"sqlite3": "^5.1.7",
"sqlstring": "^2.3.3",
"vite-tsconfig-paths": "^5.1.3"
},
"devDependencies": {
"@electron/rebuild": "^3.7.1",
"@eslint/js": "^9.13.0",
"@iconify-icon/react": "^2.1.0",
"@types/better-sqlite3": "^7.6.12",
"@types/gulp": "^4.0.17",
"@types/memory-cache": "^0.2.6",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@types/screenshot-desktop": "^1.12.3",
"@types/sqlstring": "^2.3.2",
"@vitejs/plugin-react": "^4.3.3",
"autoprefixer": "^10.4.19",
"concurrently": "^9.0.1",
"cross-env": "^7.0.3",
"del": "^8.0.0",
"electron": "^33.2.0",
"electron-build": "^0.0.3",
"electron-builder": "^25.1.8",
"eslint": "^9.13.0",
"eslint-plugin-react-hooks": "^5.0.0",
"eslint-plugin-react-refresh": "^0.4.14",
"globals": "^15.11.0",
"gulp": "^5.0.0",
"gulp-clean": "^0.4.0",
"gulp-typescript": "6.0.0-alpha.1",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.15",
"typescript": "~5.6.2",
"typescript-eslint": "^8.11.0",
"vite": "^5.4.10",
"vite-plugin-chunk-split": "^0.5.0"
}
"name": "openrewind",
"version": "0.6.0",
"type": "module",
"description": "Your second brain, superpowered.",
"main": "dist/electron/index.js",
"scripts": {
"dev": "cross-env NODE_ENV=dev bun run dev:all",
"dev:all": "concurrently -n=react,electron -c='#ff3e00',blue \"bun run dev:react\" \"bun run dev:electron\"",
"dev:react": "vite dev",
"dev:electron": "bunx gulp build && electron dist/electron/index.js",
"build:react": "vite build",
"build:app": "bunx gulp build",
"build:electron": "electron-builder",
"format": "bunx prettier --write ."
},
"keywords": [],
"author": "",
"license": "MIT",
"dependencies": {
"@alikia/random-key": "npm:@jsr/alikia__random-key",
"@electron/remote": "^2.1.2",
"@hono/node-server": "^1.13.7",
"@unly/universal-language-detector": "^2.0.3",
"better-sqlite3": "^11.6.0",
"detect-port": "^2.1.0",
"electron-context-menu": "^4.0.4",
"electron-reloader": "^1.2.3",
"electron-screencapture": "^1.1.0",
"electron-serve": "^2.1.1",
"electron-store": "^10.0.0",
"electron-window-state": "^5.0.3",
"execa": "^9.5.1",
"hono": "^4.6.15",
"i18next": "^24.0.2",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-electron-fs-backend": "^3.0.2",
"i18next-fs-backend": "^2.6.0",
"i18next-icu": "^2.3.0",
"image-size": "^1.1.1",
"memory-cache": "^0.2.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-i18next": "^15.1.2",
"react-router": "^7.0.1",
"react-router-dom": "^7.0.1",
"screenshot-desktop": "^1.15.0",
"sqlite3": "^5.1.7",
"sqlstring": "^2.3.3",
"vite-tsconfig-paths": "^5.1.3"
},
"devDependencies": {
"@electron/rebuild": "^3.7.1",
"@eslint/js": "^9.13.0",
"@iconify-icon/react": "^2.1.0",
"@types/better-sqlite3": "^7.6.12",
"@types/gulp": "^4.0.17",
"@types/memory-cache": "^0.2.6",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@types/screenshot-desktop": "^1.12.3",
"@types/sqlstring": "^2.3.2",
"@vitejs/plugin-react": "^4.3.3",
"autoprefixer": "^10.4.19",
"concurrently": "^9.0.1",
"cross-env": "^7.0.3",
"del": "^8.0.0",
"electron": "^33.2.0",
"electron-build": "^0.0.3",
"electron-builder": "^25.1.8",
"eslint": "^9.13.0",
"eslint-plugin-react-hooks": "^5.0.0",
"eslint-plugin-react-refresh": "^0.4.14",
"globals": "^15.11.0",
"gulp": "^5.0.0",
"gulp-clean": "^0.4.0",
"gulp-typescript": "6.0.0-alpha.1",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.15",
"typescript": "~5.6.2",
"typescript-eslint": "^8.11.0",
"vite": "^5.4.10",
"vite-plugin-chunk-split": "^0.5.0"
}
}

4
pages/rewind/index.css
View File

@ -1,3 +1,3 @@
body {
margin: 0;
}
margin: 0;
}

5
pages/rewind/index.tsx
View File

@ -1,12 +1,9 @@
import "./index.css";
export default function RewindPage() {
return (
<>
<div className="w-screen h-screen relative dark:text-white">
</div>
<div className="w-screen h-screen relative dark:text-white"></div>
</>
);
}

14
pages/settings/index.css
View File

@ -1,19 +1,19 @@
#root {
overflow: hidden;
user-select: none;
overflow: hidden;
user-select: none;
}
#settings-note a {
@apply text-blue-700 dark:text-[#66ccff]
@apply text-blue-700 dark:text-[#66ccff];
}
.text-weaken {
@apply text-gray-700 dark:text-gray-300;
@apply text-gray-700 dark:text-gray-300;
}
#settings-scroll-container::-webkit-scrollbar {
display: none;
display: none;
}
#settings-scroll-container {
scrollbar-width: none;
}
scrollbar-width: none;
}

2
pages/settings/index.tsx
View File

@ -36,7 +36,7 @@ function TitleBar() {
<div
className="z-50 absolute right-2.5 top-2.5 bg-red-500 hover:bg-rose-400 h-3 w-3 rounded-full"
onClick={() => {
console.log(window.settingsWindow)
console.log(window.settingsWindow);
window.settingsWindow.close();
}}
>

29
src/electron/backend/init.ts
View File

@ -6,21 +6,23 @@ import { getDatabaseDir } from "../utils/backend.js";
import { migrate } from "./migrate/index.js";
function getLibSimpleExtensionPath() {
switch (process.platform) {
case "win32":
return path.join(__dirname, "bin", process.platform, "libsimple", "simple.dll");
case "darwin":
return path.join(__dirname, "bin", process.platform, "libsimple", "libsimple.dylib");
case "linux":
return path.join(__dirname, "bin", process.platform, "libsimple", "libsimple.so");
default:
throw new Error("Unsupported platform");
}
switch (process.platform) {
case "win32":
return path.join(__dirname, "bin", process.platform, "libsimple", "simple.dll");
case "darwin":
return path.join(__dirname, "bin", process.platform, "libsimple", "libsimple.dylib");
case "linux":
return path.join(__dirname, "bin", process.platform, "libsimple", "libsimple.so");
default:
throw new Error("Unsupported platform");
}
}
function databaseInitialized(db: Database) {
return db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='frame';`).get()
!== undefined;
return (
db.prepare(`SELECT name FROM sqlite_master WHERE type='table' AND name='frame';`).get() !==
undefined
);
}
function init(db: Database) {
@ -147,8 +149,7 @@ export async function initDatabase() {
if (!databaseInitialized(db)) {
init(db);
}
else {
} else {
migrate(db);
}

13
src/electron/backend/migrate/migrateToV2.ts
View File

@ -55,9 +55,9 @@ function initSchemaInV2(db: Database) {
}
/*
* This function assumes that the database does not contain the "config" table,
* and thus needs to be migrated to Version 2.
* */
* This function assumes that the database does not contain the "config" table,
* and thus needs to be migrated to Version 2.
* */
export function migrateToV2(db: Database) {
initSchemaInV2(db);
@ -65,12 +65,11 @@ export function migrateToV2(db: Database) {
// Before: /Users/username/Library/Application Support/OpenRewind/Record Data/temp/screenshots/1733568609960.jpg
// After: 1733568609960.jpg
const rows = db.prepare("SELECT id, imgFilename FROM frame").all() as OldFrame[];
rows.forEach(row => {
rows.forEach((row) => {
const filename = row.imgFilename.match(/[^\\/]+$/)?.[0];
if (filename) {
db.prepare("UPDATE frame SET imgFilename = ? WHERE id = ?")
.run(filename, row.id);
db.prepare("UPDATE frame SET imgFilename = ? WHERE id = ?").run(filename, row.id);
}
});
@ -78,4 +77,4 @@ export function migrateToV2(db: Database) {
ALTER TABLE frame ADD encodeStatus INT DEFAULT 0;
UPDATE frame SET encodeStatus = CASE WHEN encoded THEN 2 ELSE 0 END;
`);
}
}

40
src/electron/backend/migrate/migrateToV3.ts
View File

@ -24,7 +24,10 @@ function transformEncodingTask(db: Database) {
`;
db.exec(createTableSql);
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, createdAt FROM encoding_task`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE encoding_task SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
@ -55,10 +58,13 @@ function transformFrame(db: Database) {
DROP TABLE frame;
ALTER TABLE frame_new RENAME TO frame;
ALTER TABLE frame ADD COLUMN createdAt_new REAL;
`
`;
db.exec(createTableSql);
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, createdAt FROM frame`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStmt = db.prepare(`UPDATE frame SET createdAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
const unixTimestamp = convertTimestampToUnix(row.createdAt as string);
@ -92,7 +98,10 @@ function transformSegments(db: Database) {
ALTER TABLE segments ADD COLUMN startedAt_new REAL;
ALTER TABLE segments ADD COLUMN endedAt_new REAL;
`);
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as { [x: string]: unknown; id: unknown; }[];
const rows = db.prepare(`SELECT id, startedAt, endedAt FROM segments`).all() as {
[x: string]: unknown;
id: unknown;
}[];
const updateStart = db.prepare(`UPDATE segments SET startedAt_new = ? WHERE id = ?`);
const updateEnd = db.prepare(`UPDATE segments SET endedAt_new = ? WHERE id = ?`);
rows.forEach((row) => {
@ -108,8 +117,17 @@ function transformSegments(db: Database) {
`);
}
function renameColumn(tableName: string, oldColumnName: string, newColumnName: string, db: Database) {
if (db.prepare(`SELECT 1 FROM pragma_table_info(?) WHERE name=?`).get([tableName, oldColumnName])) {
function renameColumn(
tableName: string,
oldColumnName: string,
newColumnName: string,
db: Database
) {
if (
db
.prepare(`SELECT 1 FROM pragma_table_info(?) WHERE name=?`)
.get([tableName, oldColumnName])
) {
db.exec(`ALTER TABLE ${tableName} RENAME COLUMN ${oldColumnName} TO ${newColumnName};`);
}
}
@ -173,10 +191,10 @@ export function migrateToV3(db: Database) {
PRAGMA foreign_keys = ON;
`);
renameColumn('encoding_task', 'createAt', 'createdAt', db);
renameColumn('frame', 'createAt', 'createdAt', db);
renameColumn('segments', 'startAt', 'startedAt', db);
renameColumn('segments', 'endAt', 'endedAt', db);
renameColumn("encoding_task", "createAt", "createdAt", db);
renameColumn("frame", "createAt", "createdAt", db);
renameColumn("segments", "startAt", "startedAt", db);
renameColumn("segments", "endAt", "endedAt", db);
if (db.prepare(`SELECT 1 FROM pragma_table_info('frame') WHERE name='encoded'`).get()) {
db.prepare(`ALTER TABLE frame DROP COLUMN encoded`).run();
}
@ -188,4 +206,4 @@ export function migrateToV3(db: Database) {
db.exec(`
UPDATE config SET value = '3' WHERE key = 'version';
`);
}
}

3
src/electron/backend/schema.d.ts vendored
View File

@ -9,7 +9,6 @@ export interface Frame {
encodeStatus: number;
}
export interface EncodingTask {
id: number;
createdAt: number;
@ -19,4 +18,4 @@ export interface EncodingTask {
export interface EncodingTaskData {
encodingTaskID: number;
frame: number;
}
}

23
src/electron/backend/screenshot.ts
View File

@ -1,7 +1,7 @@
import screenshot from "screenshot-desktop";
import { getScreenshotsDir } from "../utils/backend.js";
import { join } from "path";
import { Database }from "better-sqlite3";
import { Database } from "better-sqlite3";
import SqlString from "sqlstring";
export function startScreenshotLoop(db: Database) {
@ -10,15 +10,16 @@ export function startScreenshotLoop(db: Database) {
const screenshotDir = getScreenshotsDir();
const filename = `${timestamp}.png`;
const screenshotPath = join(screenshotDir, filename);
screenshot({filename: screenshotPath, format: "png"}).then((absolutePath) => {
const SQL = SqlString.format(
"INSERT INTO frame (imgFilename, createdAt) VALUES (?, ?)",
[filename, new Date().getTime() / 1000]
);
db.exec(SQL);
}).catch((err) => {
console.error(err);
});
screenshot({ filename: screenshotPath, format: "png" })
.then((absolutePath) => {
const SQL = SqlString.format(
"INSERT INTO frame (imgFilename, createdAt) VALUES (?, ?)",
[filename, new Date().getTime() / 1000]
);
db.exec(SQL);
})
.catch((err) => {
console.error(err);
});
}, 2000);
}

25
src/electron/createWindow.ts
View File

@ -10,13 +10,14 @@ function loadURL(window: BrowserWindow, path = "", vitePort: string) {
window.loadURL(`http://localhost:${vitePort}/#${path}`).catch((e) => {
console.log("Error loading URL:", e);
});
}
else {
window.loadFile(join(__dirname, "../renderer/index.html"), {
hash: path,
}).catch((e) => {
console.log("Error loading URL:", e);
});
} else {
window
.loadFile(join(__dirname, "../renderer/index.html"), {
hash: path
})
.catch((e) => {
console.log("Error loading URL:", e);
});
}
}
@ -26,9 +27,9 @@ export function createSettingsWindow(vitePort: string, closeCallBack: Function)
defaultHeight: 550
});
const enableFrame = process.platform === "darwin";
let icon
let icon;
switch (process.platform) {
case "darwin":
case "darwin":
icon = undefined;
break;
case "win32":
@ -46,13 +47,13 @@ export function createSettingsWindow(vitePort: string, closeCallBack: Function)
webPreferences: {
nodeIntegration: true,
contextIsolation: true,
preload: join(__dirname, 'preload/settings.cjs')
preload: join(__dirname, "preload/settings.cjs")
},
titleBarStyle: "hiddenInset",
resizable: false,
show: false,
frame: enableFrame,
icon: icon,
icon: icon
});
windowState.manage(window);
window.on("show", () => {
@ -92,7 +93,7 @@ export function createMainWindow(vitePort: string, closeCallBack: Function) {
webPreferences: {
nodeIntegration: true,
contextIsolation: true,
preload: join(__dirname, 'preload/rewind.cjs')
preload: join(__dirname, "preload/rewind.cjs")
},
roundedCorners: false,
transparent: true,

4
src/electron/i18n.ts
View File

@ -4,7 +4,6 @@ import fs from "fs";
import { app } from "electron";
import { __dirname } from "./dirname.js";
/**
* Selects the appropriate language based on system preferences and available languages
*
@ -21,7 +20,7 @@ export function detectLanguage(langs: string[], fallback: string): string {
const normalizedLang = systemLanguage.toLowerCase().split("-")[0];
// Find a matching language
const matchedLanguage = langs.find(lang => {
const matchedLanguage = langs.find((lang) => {
if (lang.indexOf(normalizedLang) !== -1) {
return lang;
}
@ -53,4 +52,3 @@ export default function initI18n() {
});
return i18n;
}

34
src/electron/index.ts
View File

@ -1,4 +1,13 @@
import { app, BrowserWindow, globalShortcut, ipcMain, Menu, nativeImage, screen, Tray } from "electron";
import {
app,
BrowserWindow,
globalShortcut,
ipcMain,
Menu,
nativeImage,
screen,
Tray
} from "electron";
import contextMenu from "electron-context-menu";
import { join } from "path";
import initI18n from "./i18n.js";
@ -8,12 +17,16 @@ import { Database } from "better-sqlite3";
import { startScreenshotLoop } from "./backend/screenshot.js";
import { __dirname } from "./dirname.js";
import { hideDock } from "./utils/electron.js";
import { checkFramesForEncoding, deleteUnnecessaryScreenshots, processEncodingTasks } from "./backend/encoding.js";
import {
checkFramesForEncoding,
deleteUnnecessaryScreenshots,
processEncodingTasks
} from "./backend/encoding.js";
import honoApp from "./server/index.js";
import { serve } from "@hono/node-server";
import { findAvailablePort } from "./utils/server.js";
import cache from "memory-cache";
import { generate } from '@alikia/random-key';
import { generate } from "@alikia/random-key";
const i18n = initI18n();
@ -75,21 +88,19 @@ contextMenu({
app.once("ready", () => {
hideDock();
});
app.on("activate", () => {
});
app.on("activate", () => {});
app.on("ready", () => {
createTray();
findAvailablePort(12412).then((port) => {
generate().then((key) => {
cache.put("server:APIKey",key);
cache.put("server:APIKey", key);
cache.put("server:port", port);
if (dev)
console.log(`API Key: ${key}`);
if (dev) console.log(`API Key: ${key}`);
serve({ fetch: honoApp.fetch, port: port });
console.log(`App server running on port ${port}`);
});
})
});
initDatabase().then((db) => {
screenshotInterval = startScreenshotLoop(db);
setInterval(checkFramesForEncoding, 5000, db);
@ -108,8 +119,7 @@ app.on("ready", () => {
app.on("will-quit", () => {
dbConnection?.close();
if (screenshotInterval)
clearInterval(screenshotInterval);
if (screenshotInterval) clearInterval(screenshotInterval);
});
// app.on("window-all-closed", () => {
@ -118,4 +128,4 @@ app.on("will-quit", () => {
ipcMain.on("close-settings", () => {
settingsWindow?.hide();
});
});

114
src/electron/preload/os-name.cjs
View File

@ -1,52 +1,52 @@
const os = require('node:os');
const os = require("node:os");
const nameMap = new Map([
[24, ['Sequoia', '15']],
[23, ['Sonoma', '14']],
[22, ['Ventura', '13']],
[21, ['Monterey', '12']],
[20, ['Big Sur', '11']],
[19, ['Catalina', '10.15']],
[18, ['Mojave', '10.14']],
[17, ['High Sierra', '10.13']],
[16, ['Sierra', '10.12']],
[15, ['El Capitan', '10.11']],
[14, ['Yosemite', '10.10']],
[13, ['Mavericks', '10.9']],
[12, ['Mountain Lion', '10.8']],
[11, ['Lion', '10.7']],
[10, ['Snow Leopard', '10.6']],
[9, ['Leopard', '10.5']],
[8, ['Tiger', '10.4']],
[7, ['Panther', '10.3']],
[6, ['Jaguar', '10.2']],
[5, ['Puma', '10.1']],
[24, ["Sequoia", "15"]],
[23, ["Sonoma", "14"]],
[22, ["Ventura", "13"]],
[21, ["Monterey", "12"]],
[20, ["Big Sur", "11"]],
[19, ["Catalina", "10.15"]],
[18, ["Mojave", "10.14"]],
[17, ["High Sierra", "10.13"]],
[16, ["Sierra", "10.12"]],
[15, ["El Capitan", "10.11"]],
[14, ["Yosemite", "10.10"]],
[13, ["Mavericks", "10.9"]],
[12, ["Mountain Lion", "10.8"]],
[11, ["Lion", "10.7"]],
[10, ["Snow Leopard", "10.6"]],
[9, ["Leopard", "10.5"]],
[8, ["Tiger", "10.4"]],
[7, ["Panther", "10.3"]],
[6, ["Jaguar", "10.2"]],
[5, ["Puma", "10.1"]]
]);
const names = new Map([
['10.0.2', '11'], // It's unclear whether future Windows 11 versions will use this version scheme: https://github.com/sindresorhus/windows-release/pull/26/files#r744945281
['10.0', '10'],
['6.3', '8.1'],
['6.2', '8'],
['6.1', '7'],
['6.0', 'Vista'],
['5.2', 'Server 2003'],
['5.1', 'XP'],
['5.0', '2000'],
['4.90', 'ME'],
['4.10', '98'],
['4.03', '95'],
['4.00', '95'],
["10.0.2", "11"], // It's unclear whether future Windows 11 versions will use this version scheme: https://github.com/sindresorhus/windows-release/pull/26/files#r744945281
["10.0", "10"],
["6.3", "8.1"],
["6.2", "8"],
["6.1", "7"],
["6.0", "Vista"],
["5.2", "Server 2003"],
["5.1", "XP"],
["5.0", "2000"],
["4.90", "ME"],
["4.10", "98"],
["4.03", "95"],
["4.00", "95"]
]);
function macosRelease(release) {
release = Number((release || os.release()).split('.')[0]);
release = Number((release || os.release()).split(".")[0]);
const [name, version] = nameMap.get(release) || ['Unknown', ''];
const [name, version] = nameMap.get(release) || ["Unknown", ""];
return {
name,
version,
version
};
}
@ -54,14 +54,14 @@ function windowsRelease(release) {
const version = /(\d+\.\d+)(?:\.(\d+))?/.exec(release || os.release());
if (release && !version) {
throw new Error('`release` argument doesn\'t match `n.n`');
throw new Error("`release` argument doesn't match `n.n`");
}
let ver = version[1] || '';
const build = version[2] || '';
let ver = version[1] || "";
const build = version[2] || "";
if (ver === '10.0' && build.startsWith('2')) {
ver = '10.0.2';
if (ver === "10.0" && build.startsWith("2")) {
ver = "10.0.2";
}
return names.get(ver);
@ -69,47 +69,47 @@ function windowsRelease(release) {
function osName(platform, release) {
if (!platform && release) {
throw new Error('You can\'t specify a `release` without specifying `platform`');
throw new Error("You can't specify a `release` without specifying `platform`");
}
platform = platform ?? os.platform();
let id;
if (platform === 'darwin') {
if (!release && os.platform() === 'darwin') {
if (platform === "darwin") {
if (!release && os.platform() === "darwin") {
release = os.release();
}
const prefix = release ? (Number(release.split('.')[0]) > 15 ? 'macOS' : 'OS X') : 'macOS';
const prefix = release ? (Number(release.split(".")[0]) > 15 ? "macOS" : "OS X") : "macOS";
try {
id = release ? macosRelease(release).name : '';
id = release ? macosRelease(release).name : "";
if (id === 'Unknown') {
if (id === "Unknown") {
return prefix;
}
} catch {}
return prefix + (id ? ' ' + id : '');
return prefix + (id ? " " + id : "");
}
if (platform === 'linux') {
if (!release && os.platform() === 'linux') {
if (platform === "linux") {
if (!release && os.platform() === "linux") {
release = os.release();
}
id = release ? release.replace(/^(\d+\.\d+).*/, '$1') : '';
return 'Linux' + (id ? ' ' + id : '');
id = release ? release.replace(/^(\d+\.\d+).*/, "$1") : "";
return "Linux" + (id ? " " + id : "");
}
if (platform === 'win32') {
if (!release && os.platform() === 'win32') {
if (platform === "win32") {
if (!release && os.platform() === "win32") {
release = os.release();
}
id = release ? windowsRelease(release) : '';
return 'Windows' + (id ? ' ' + id : '');
id = release ? windowsRelease(release) : "";
return "Windows" + (id ? " " + id : "");
}
return platform;

22
src/electron/utils/electron.ts
View File

@ -1,15 +1,15 @@
import { app } from "electron";
export function hideDock(){
if (process.platform === 'darwin') {
// Hide the dock icon on macOS
app.dock.hide();
}
export function hideDock() {
if (process.platform === "darwin") {
// Hide the dock icon on macOS
app.dock.hide();
}
}
export function showDock(){
if (process.platform === 'darwin') {
// Show the dock icon on macOS
app.dock.show();
}
}
export function showDock() {
if (process.platform === "darwin") {
// Show the dock icon on macOS
app.dock.show();
}
}

8
src/electron/utils/server.ts
View File

@ -1,4 +1,4 @@
import { detect } from 'detect-port';
import { detect } from "detect-port";
/**
* Finds an available port starting from a given port.
@ -7,11 +7,11 @@ import { detect } from 'detect-port';
*/
export async function findAvailablePort(startingFrom: number): Promise<number> {
return detect(startingFrom)
.then(realPort => {
.then((realPort) => {
return realPort; // Return the available port
})
.catch(err => {
.catch((err) => {
console.error(`Error detecting port: ${err.message}`);
throw err; // Rethrow the error for further handling if needed
});
}
}

16
src/global.d.ts vendored
View File

@ -7,13 +7,13 @@ interface Window {
osDisplay: () => string;
};
electron: {
getScreenshot: () => Promise<string>;
}
getScreenshot: () => Promise<string>;
};
api: {
send: (channel: any, data: any) => void,
receive: (channel: any, func: any) => void
},
send: (channel: any, data: any) => void;
receive: (channel: any, func: any) => void;
};
settingsWindow: {
close: () => void,
}
}
close: () => void;
};
}

4
src/renderer/app.css
View File

@ -1,3 +1,3 @@
#title-bar {
-webkit-app-region: drag;
}
-webkit-app-region: drag;
}

2
src/renderer/app.tsx
View File

@ -2,7 +2,7 @@ import { HashRouter, Routes, Route } from "react-router-dom";
import SettingsPage from "pages/settings";
import "./i18n.ts";
import RewindPage from "pages/rewind";
import './app.css';
import "./app.css";
export function App() {
return (

2
src/renderer/i18n.ts
View File

@ -38,7 +38,7 @@ i18n.use(initReactI18next) // passes i18n down to react-i18next
},
ko: {
translation: ko
},
}
},
fallbackLng: "en",

4
src/renderer/index.css
View File

@ -3,5 +3,5 @@
@tailwind utilities;
body {
@apply bg-transparent;
}
@apply bg-transparent;
}

16
src/renderer/index.html
View File

@ -1,11 +1,11 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div id="root"></div>
<script type="module" src="./main.tsx"></script>
</body>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div id="root"></div>
<script type="module" src="./main.tsx"></script>
</body>
</html>

6
src/renderer/main.tsx
View File

@ -6,7 +6,7 @@ import "./index.css";
const app = createRoot(document.getElementById("root")!);
app.render(
<StrictMode>
<App />
</StrictMode>
<StrictMode>
<App />
</StrictMode>
);

2
tailwind.config.ts
View File

@ -4,7 +4,7 @@ const config: Config = {
content: [
"./pages/**/*.{js,ts,jsx,tsx,mdx}",
"./components/**/*.{js,ts,jsx,tsx,mdx}",
"./src/**/*.{js,ts,jsx,tsx,mdx}",
"./src/**/*.{js,ts,jsx,tsx,mdx}"
],
theme: {
extend: {

62
tsconfig.app.json
View File

@ -1,35 +1,35 @@
{
"compilerOptions": {
"baseUrl": ".",
"composite": true,
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
"compilerOptions": {
"baseUrl": ".",
"composite": true,
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"emitDeclarationOnly": true,
"resolveJsonModule": true,
"isolatedModules": true,
"moduleDetection": "force",
"jsx": "react-jsx",
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"emitDeclarationOnly": true,
"resolveJsonModule": true,
"isolatedModules": true,
"moduleDetection": "force",
"jsx": "react-jsx",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": [
"src/renderer",
"src/renderer/**/*.ts",
"src/renderer/**/*.tsx",
"src/global.d.ts",
"pages/**/*.tsx",
"components/**/*.tsx"
],
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": [
"src/renderer",
"src/renderer/**/*.ts",
"src/renderer/**/*.tsx",
"src/global.d.ts",
"pages/**/*.tsx",
"components/**/*.tsx"
]
}

29
tsconfig.json
View File

@ -1,18 +1,15 @@
{
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "bundler",
"outDir": "./dist/electron",
"rootDir": "./src/electron",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src/electron"],
"references": [
{ "path": "./tsconfig.app.json"},
{ "path": "./tsconfig.node.json"}
]
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "bundler",
"outDir": "./dist/electron",
"rootDir": "./src/electron",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src/electron"],
"references": [{ "path": "./tsconfig.app.json" }, { "path": "./tsconfig.node.json" }]
}

40
tsconfig.node.json
View File

@ -1,25 +1,23 @@
{
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"target": "ES2022",
"lib": ["ES2023"],
"module": "ESNext",
"skipLibCheck": true,
"composite": true,
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"target": "ES2022",
"lib": ["ES2023"],
"module": "ESNext",
"skipLibCheck": true,
"composite": true,
/* Bundler mode */
"moduleResolution": "Bundler",
"isolatedModules": true,
"moduleDetection": "force",
/* Bundler mode */
"moduleResolution": "Bundler",
"isolatedModules": true,
"moduleDetection": "force",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": [
"vite.config.ts"
]
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": ["vite.config.ts"]
}

6
vite.config.ts
View File

@ -19,10 +19,10 @@ export default defineConfig({
customChunk: (args) => {
// files into pages directory is export in single files
const { id } = args;
if (id.includes('node_modules')) {
return 'vendor';
if (id.includes("node_modules")) {
return "vendor";
} else {
return 'main';
return "main";
}
}
})