aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authoradripo <26493496+adripo@users.noreply.github.com>2025-04-21 19:59:40 +0200
committerGitHub <noreply@github.com>2025-04-21 18:59:40 +0100
commit4296e7f4d8de64a62dbf5e5d152b19ae25df489e (patch)
treea976ea13ec1396078de2047fdcb125bb086c6a17 /packages
parent86728d7f0e48e5cf8fbd1977240909302b2d8ad9 (diff)
downloadkarakeep-4296e7f4d8de64a62dbf5e5d152b19ae25df489e.tar.zst
chore: rename missing files/conf from Hoarder to Karakeep (#1280)
* refactor: Rename remaining project configuration from Hoarder to Karakeep * some fixes --------- Co-authored-by: Mohamed Bassem <me@mbassem.com>
Diffstat (limited to 'packages')
-rw-r--r--packages/db/index.ts2
-rw-r--r--packages/e2e_tests/docker-compose.yml2
-rw-r--r--packages/e2e_tests/setup/startContainers.ts8
-rw-r--r--packages/e2e_tests/tests/api/assets.test.ts8
-rw-r--r--packages/e2e_tests/tests/api/bookmarks.test.ts8
-rw-r--r--packages/e2e_tests/tests/api/highlights.test.ts8
-rw-r--r--packages/e2e_tests/tests/api/lists.test.ts8
-rw-r--r--packages/e2e_tests/tests/api/tags.test.ts8
-rw-r--r--packages/e2e_tests/tests/api/users.test.ts8
-rw-r--r--packages/e2e_tests/tests/workers/crawler.test.ts2
-rw-r--r--packages/e2e_tests/utils/trpc.ts2
-rw-r--r--packages/open-api/index.ts10
-rw-r--r--packages/open-api/karakeep-openapi-spec.json (renamed from packages/open-api/hoarder-openapi-spec.json)8
-rw-r--r--packages/sdk/package.json3
-rw-r--r--packages/sdk/src/index.ts2
-rw-r--r--packages/sdk/src/karakeep-api.d.ts (renamed from packages/sdk/src/hoarder-api.d.ts)0
16 files changed, 44 insertions, 43 deletions
diff --git a/packages/db/index.ts b/packages/db/index.ts
index 8a33d488..0a72c9bb 100644
--- a/packages/db/index.ts
+++ b/packages/db/index.ts
@@ -10,7 +10,7 @@ export * as schema from "./schema";
export { SqliteError } from "better-sqlite3";
// This is exported here to avoid leaking better-sqlite types outside of this package.
-export type HoarderDBTransaction = SQLiteTransaction<
+export type KarakeepDBTransaction = SQLiteTransaction<
"sync",
Database.RunResult,
typeof schema,
diff --git a/packages/e2e_tests/docker-compose.yml b/packages/e2e_tests/docker-compose.yml
index c48d4d63..201db154 100644
--- a/packages/e2e_tests/docker-compose.yml
+++ b/packages/e2e_tests/docker-compose.yml
@@ -6,7 +6,7 @@ services:
target: aio
restart: unless-stopped
ports:
- - "${HOARDER_PORT:-3000}:3000"
+ - "${KARAKEEP_PORT:-3000}:3000"
environment:
DATA_DIR: /tmp
NEXTAUTH_SECRET: secret
diff --git a/packages/e2e_tests/setup/startContainers.ts b/packages/e2e_tests/setup/startContainers.ts
index df07cc58..3086d1c8 100644
--- a/packages/e2e_tests/setup/startContainers.ts
+++ b/packages/e2e_tests/setup/startContainers.ts
@@ -39,7 +39,7 @@ export default async function ({ provide }: GlobalSetupContext) {
stdio: "inherit",
env: {
...process.env,
- HOARDER_PORT: port.toString(),
+ KARAKEEP_PORT: port.toString(),
},
});
@@ -49,9 +49,9 @@ export default async function ({ provide }: GlobalSetupContext) {
// Wait 5 seconds for the worker to start
await new Promise((resolve) => setTimeout(resolve, 5000));
- provide("hoarderPort", port);
+ provide("karakeepPort", port);
- process.env.HOARDER_PORT = port.toString();
+ process.env.KARAKEEP_PORT = port.toString();
return async () => {
console.log("Stopping docker compose...");
@@ -65,6 +65,6 @@ export default async function ({ provide }: GlobalSetupContext) {
declare module "vitest" {
export interface ProvidedContext {
- hoarderPort: number;
+ karakeepPort: number;
}
}
diff --git a/packages/e2e_tests/tests/api/assets.test.ts b/packages/e2e_tests/tests/api/assets.test.ts
index 8de3c411..5c294929 100644
--- a/packages/e2e_tests/tests/api/assets.test.ts
+++ b/packages/e2e_tests/tests/api/assets.test.ts
@@ -1,22 +1,22 @@
import { assert, beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser, uploadTestAsset } from "../../utils/api";
describe("Assets API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/api/bookmarks.test.ts b/packages/e2e_tests/tests/api/bookmarks.test.ts
index 91fbcc20..6c56f689 100644
--- a/packages/e2e_tests/tests/api/bookmarks.test.ts
+++ b/packages/e2e_tests/tests/api/bookmarks.test.ts
@@ -1,22 +1,22 @@
import { assert, beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser } from "../../utils/api";
describe("Bookmarks API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/api/highlights.test.ts b/packages/e2e_tests/tests/api/highlights.test.ts
index 1523dc91..4776d06d 100644
--- a/packages/e2e_tests/tests/api/highlights.test.ts
+++ b/packages/e2e_tests/tests/api/highlights.test.ts
@@ -1,22 +1,22 @@
import { beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser } from "../../utils/api";
describe("Highlights API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/api/lists.test.ts b/packages/e2e_tests/tests/api/lists.test.ts
index 2d6ab98c..caddfd87 100644
--- a/packages/e2e_tests/tests/api/lists.test.ts
+++ b/packages/e2e_tests/tests/api/lists.test.ts
@@ -1,22 +1,22 @@
import { beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser } from "../../utils/api";
describe("Lists API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/api/tags.test.ts b/packages/e2e_tests/tests/api/tags.test.ts
index 3355bc1e..3e3cacc0 100644
--- a/packages/e2e_tests/tests/api/tags.test.ts
+++ b/packages/e2e_tests/tests/api/tags.test.ts
@@ -1,22 +1,22 @@
import { beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser } from "../../utils/api";
describe("Tags API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/api/users.test.ts b/packages/e2e_tests/tests/api/users.test.ts
index fb33fdca..096e4b54 100644
--- a/packages/e2e_tests/tests/api/users.test.ts
+++ b/packages/e2e_tests/tests/api/users.test.ts
@@ -1,22 +1,22 @@
import { beforeEach, describe, expect, inject, it } from "vitest";
-import { createHoarderClient } from "@karakeep/sdk";
+import { createKarakeepClient } from "@karakeep/sdk";
import { createTestUser } from "../../utils/api";
describe("Users API", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
}
- let client: ReturnType<typeof createHoarderClient>;
+ let client: ReturnType<typeof createKarakeepClient>;
let apiKey: string;
beforeEach(async () => {
apiKey = await createTestUser();
- client = createHoarderClient({
+ client = createKarakeepClient({
baseUrl: `http://localhost:${port}/api/v1/`,
headers: {
"Content-Type": "application/json",
diff --git a/packages/e2e_tests/tests/workers/crawler.test.ts b/packages/e2e_tests/tests/workers/crawler.test.ts
index df276cae..cafc50cc 100644
--- a/packages/e2e_tests/tests/workers/crawler.test.ts
+++ b/packages/e2e_tests/tests/workers/crawler.test.ts
@@ -6,7 +6,7 @@ import { createTestUser } from "../../utils/api";
import { waitUntil } from "../../utils/general";
describe("Crawler Tests", () => {
- const port = inject("hoarderPort");
+ const port = inject("karakeepPort");
if (!port) {
throw new Error("Missing required environment variables");
diff --git a/packages/e2e_tests/utils/trpc.ts b/packages/e2e_tests/utils/trpc.ts
index a13e0a83..6b4f3979 100644
--- a/packages/e2e_tests/utils/trpc.ts
+++ b/packages/e2e_tests/utils/trpc.ts
@@ -8,7 +8,7 @@ export function getTrpcClient(apiKey?: string) {
links: [
httpBatchLink({
transformer: superjson,
- url: `http://localhost:${process.env.HOARDER_PORT}/api/trpc`,
+ url: `http://localhost:${process.env.KARAKEEP_PORT}/api/trpc`,
headers() {
return {
authorization: apiKey ? `Bearer ${apiKey}` : undefined,
diff --git a/packages/open-api/index.ts b/packages/open-api/index.ts
index d96cb5ca..9186805e 100644
--- a/packages/open-api/index.ts
+++ b/packages/open-api/index.ts
@@ -27,16 +27,16 @@ function getOpenApiDocumentation() {
openapi: "3.0.0",
info: {
version: "1.0.0",
- title: "Hoarder API",
- description: "The API for the Hoarder app",
+ title: "Karakeep API",
+ description: "The API for the Karakeep app",
},
servers: [
{
url: "{address}/api/v1",
variables: {
address: {
- default: "https://try.hoarder.app",
- description: "The address of the hoarder server",
+ default: "https://try.karakeep.app",
+ description: "The address of the Karakeep server",
},
},
},
@@ -47,7 +47,7 @@ function getOpenApiDocumentation() {
function writeDocumentation() {
const docs = getOpenApiDocumentation();
const fileContent = JSON.stringify(docs, null, 2);
- fs.writeFileSync(`./hoarder-openapi-spec.json`, fileContent, {
+ fs.writeFileSync(`./karakeep-openapi-spec.json`, fileContent, {
encoding: "utf-8",
});
}
diff --git a/packages/open-api/hoarder-openapi-spec.json b/packages/open-api/karakeep-openapi-spec.json
index 9a1d8634..0f8074d4 100644
--- a/packages/open-api/hoarder-openapi-spec.json
+++ b/packages/open-api/karakeep-openapi-spec.json
@@ -2,16 +2,16 @@
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
- "title": "Hoarder API",
- "description": "The API for the Hoarder app"
+ "title": "Karakeep API",
+ "description": "The API for the Karakeep app"
},
"servers": [
{
"url": "{address}/api/v1",
"variables": {
"address": {
- "default": "https://try.hoarder.app",
- "description": "The address of the hoarder server"
+ "default": "https://try.karakeep.app",
+ "description": "The address of the Karakeep server"
}
}
}
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index eada3234..ea23a8cd 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -6,6 +6,7 @@
"license": "GNU Affero General Public License version 3",
"keywords": [
"hoarder",
+ "karakeep",
"sdk"
],
"main": "./src/index.ts",
@@ -46,7 +47,7 @@
"@karakeep/eslint-config/base"
],
"ignorePatterns": [
- "src/hoarder-api.d.ts"
+ "src/karakeep-api.d.ts"
]
},
"prettier": "@karakeep/prettier-config",
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
index 7ff0c0dc..e233e6c1 100644
--- a/packages/sdk/src/index.ts
+++ b/packages/sdk/src/index.ts
@@ -1,6 +1,6 @@
import createClient from "openapi-fetch";
-import type { components, paths } from "./hoarder-api.d.ts";
+import type { components, paths } from "./karakeep-api.d.ts";
/**
* @deprecated Use createKarakeepClient instead.
diff --git a/packages/sdk/src/hoarder-api.d.ts b/packages/sdk/src/karakeep-api.d.ts
index 0b434b3d..0b434b3d 100644
--- a/packages/sdk/src/hoarder-api.d.ts
+++ b/packages/sdk/src/karakeep-api.d.ts