@frameless/strapi-plugin-notes 1.0.0

package/dist/server/index.js

@@ -0,0 +1,116 @@
+"use strict";
+const strapi = require("@strapi/strapi");
+const noteContentType = {
+  kind: "collectionType",
+  collectionName: "notes",
+  info: {
+    singularName: "note",
+    pluralName: "notes",
+    displayName: "notes"
+  },
+  pluginOptions: {
+    "content-manager": {
+      visible: false
+    },
+    "content-type-builder": {
+      visible: false
+    }
+  },
+  options: {
+    draftAndPublish: false,
+    comment: ""
+  },
+  attributes: {
+    title: {
+      type: "string"
+    },
+    content: {
+      type: "text"
+    },
+    entitySlug: {
+      type: "string"
+    },
+    entityId: {
+      type: "string"
+    }
+  }
+};
+const contentTypes = {
+  note: { schema: noteContentType }
+};
+const noteController = strapi.factories.createCoreController("plugin::entity-notes.note", ({ strapi: strapi2 }) => ({
+  async findByDocument(ctx) {
+    const { entitySlug, documentId } = ctx.query;
+    if (!entitySlug || !documentId) {
+      return ctx.badRequest("entitySlug and documentId are required");
+    }
+    try {
+      let legacyId = null;
+      try {
+        const document = await strapi2.db.query(entitySlug).findOne({
+          where: { documentId }
+        });
+        legacyId = document?.id;
+      } catch (error) {
+        console.error(`Error fetching document for ${entitySlug} with documentId ${documentId}:`, error);
+      }
+      const entityIdFilters = [documentId];
+      if (legacyId) {
+        entityIdFilters.push(legacyId, String(legacyId));
+      }
+      const notes = await strapi2.db.query("plugin::entity-notes.note").findMany({
+        where: {
+          entitySlug: { $eq: entitySlug },
+          entityId: { $in: entityIdFilters }
+        },
+        orderBy: { title: "asc" }
+      });
+      return { data: notes };
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : "Unknown error";
+      return ctx.internalServerError("Failed to fetch notes", { error: errorMessage });
+    }
+  }
+}));
+const controllers = {
+  noteController
+};
+const noteRoutes = [
+  {
+    method: "GET",
+    path: "/notes",
+    handler: "noteController.find"
+  },
+  {
+    method: "GET",
+    path: "/notes/by-document",
+    handler: "noteController.findByDocument"
+  },
+  {
+    method: "POST",
+    path: "/notes",
+    handler: "noteController.create"
+  },
+  {
+    method: "DELETE",
+    path: "/notes/:id",
+    handler: "noteController.delete"
+  },
+  {
+    method: "PUT",
+    path: "/notes/:id",
+    handler: "noteController.update"
+  }
+];
+const routes = [...noteRoutes];
+const note = strapi.factories.createCoreService("plugin::entity-notes.note");
+const services = {
+  note
+};
+const index = {
+  controllers,
+  routes,
+  services,
+  contentTypes
+};
+module.exports = index;

package/dist/server/index.mjs

@@ -0,0 +1,117 @@
+import { factories } from "@strapi/strapi";
+const noteContentType = {
+  kind: "collectionType",
+  collectionName: "notes",
+  info: {
+    singularName: "note",
+    pluralName: "notes",
+    displayName: "notes"
+  },
+  pluginOptions: {
+    "content-manager": {
+      visible: false
+    },
+    "content-type-builder": {
+      visible: false
+    }
+  },
+  options: {
+    draftAndPublish: false,
+    comment: ""
+  },
+  attributes: {
+    title: {
+      type: "string"
+    },
+    content: {
+      type: "text"
+    },
+    entitySlug: {
+      type: "string"
+    },
+    entityId: {
+      type: "string"
+    }
+  }
+};
+const contentTypes = {
+  note: { schema: noteContentType }
+};
+const noteController = factories.createCoreController("plugin::entity-notes.note", ({ strapi }) => ({
+  async findByDocument(ctx) {
+    const { entitySlug, documentId } = ctx.query;
+    if (!entitySlug || !documentId) {
+      return ctx.badRequest("entitySlug and documentId are required");
+    }
+    try {
+      let legacyId = null;
+      try {
+        const document = await strapi.db.query(entitySlug).findOne({
+          where: { documentId }
+        });
+        legacyId = document?.id;
+      } catch (error) {
+        console.error(`Error fetching document for ${entitySlug} with documentId ${documentId}:`, error);
+      }
+      const entityIdFilters = [documentId];
+      if (legacyId) {
+        entityIdFilters.push(legacyId, String(legacyId));
+      }
+      const notes = await strapi.db.query("plugin::entity-notes.note").findMany({
+        where: {
+          entitySlug: { $eq: entitySlug },
+          entityId: { $in: entityIdFilters }
+        },
+        orderBy: { title: "asc" }
+      });
+      return { data: notes };
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : "Unknown error";
+      return ctx.internalServerError("Failed to fetch notes", { error: errorMessage });
+    }
+  }
+}));
+const controllers = {
+  noteController
+};
+const noteRoutes = [
+  {
+    method: "GET",
+    path: "/notes",
+    handler: "noteController.find"
+  },
+  {
+    method: "GET",
+    path: "/notes/by-document",
+    handler: "noteController.findByDocument"
+  },
+  {
+    method: "POST",
+    path: "/notes",
+    handler: "noteController.create"
+  },
+  {
+    method: "DELETE",
+    path: "/notes/:id",
+    handler: "noteController.delete"
+  },
+  {
+    method: "PUT",
+    path: "/notes/:id",
+    handler: "noteController.update"
+  }
+];
+const routes = [...noteRoutes];
+const note = factories.createCoreService("plugin::entity-notes.note");
+const services = {
+  note
+};
+const index = {
+  controllers,
+  routes,
+  services,
+  contentTypes
+};
+export {
+  index as default
+};

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@frameless/strapi-plugin-notes",
+  "version": "1.0.0",
+  "description": "A plugin for Strapi CMS that provides the ability to add notes to entity records.",
+  "strapi": {
+    "displayName": "Notes",
+    "description": "A plugin for Strapi Headless CMS that provides the ability to add notes to entity records.",
+    "name": "entity-notes",
+    "kind": "plugin"
+  },
+  "author": {
+    "name": "Frameless"
+  },
+  "license": "EUPL-1.2",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./strapi-admin": {
+      "types": "./dist/admin/src/index.d.ts",
+      "source": "./admin/src/index.tsx",
+      "import": "./dist/admin/index.mjs",
+      "require": "./dist/admin/index.js",
+      "default": "./dist/admin/index.js"
+    },
+    "./strapi-server": {
+      "types": "./dist/server/src/index.d.ts",
+      "source": "./server/index.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    }
+  },
+  "repository": {
+    "type": "git+ssh",
+    "url": "git@github.com:frameless/strapi-v5-extensions.git",
+    "directory": "packages/strapi-plugin-notes"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "react-intl": "8.1.3",
+    "@tanstack/react-query": "5.90.21"
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "7.28.5",
+    "@strapi/design-system": "2.1.2",
+    "@strapi/icons": "2.1.2",
+    "@strapi/sdk-plugin": "5.4.0",
+    "@strapi/strapi": "5.33.4",
+    "@strapi/typescript-utils": "5.33.4",
+    "@testing-library/jest-dom": "6.9.1",
+    "@testing-library/react": "16.3.2",
+    "@types/jest": "29.5.12",
+    "@types/node": "24.10.9",
+    "@types/react": "18.3.27",
+    "@types/react-dom": "18.3.7",
+    "@types/styled-components": "5.1.36",
+    "identity-obj-proxy": "3.0.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "koa": "3.1.2",
+    "rimraf": "6.1.3",
+    "ts-jest": "29.4.6",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.3",
+    "@frameless/eslint-config": "1.1.2",
+    "@frameless/typescript-config": "1.0.1"
+  },
+  "peerDependencies": {
+    "@strapi/design-system": ">=2.0.0",
+    "@strapi/icons": ">=2.0.0",
+    "@strapi/strapi": ">=5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "engines": {
+    "node": ">=22.0.0 <25",
+    "pnpm": ">=10.0.0"
+  },
+  "keywords": [
+    "strapi",
+    "strapi-plugin",
+    "plugin",
+    "strapi plugin",
+    "notes"
+  ],
+  "scripts": {
+    "build": "strapi-plugin build",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link",
+    "verify": "strapi-plugin verify",
+    "lint-build": "tsc --noEmit --project tsconfig.json && tsc --noEmit --project tsconfig.server.json",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "clean": "rimraf .next .strapi dist",
+    "test": "jest --passWithNoTests"
+  }
+}