strapi-plugin-document-metadata 1.0.1

package/dist/server/index.mjs

@@ -0,0 +1,120 @@
+const bootstrap = ({ strapi }) => {
+};
+const destroy = ({ strapi }) => {
+};
+const register = ({ strapi }) => {
+};
+const config = {
+  default: {},
+  validator() {
+  }
+};
+const contentTypes = {};
+const controller = ({ strapi }) => ({
+  /**
+   * Controller method for the route that fetches and updates the last-opened fields
+   * of a document with the given `uid` and `documentId` path parameters (GET request).
+   */
+  async lastOpened(ctx) {
+    const { uid, documentId } = ctx.params;
+    const { locale } = ctx.request.query;
+    const previousLastOpened = await strapi.plugin("document-metadata").service("service").fetchLastOpened({ uid, documentId, locale });
+    const openedAt = (/* @__PURE__ */ new Date()).toISOString();
+    const { user } = ctx.state;
+    const openedBy = `${user.firstname} ${user.lastname}`;
+    await strapi.plugin("document-metadata").service("service").updateLastOpened({ uid, documentId, locale, openedAt, openedBy });
+    ctx.response.body = previousLastOpened;
+  }
+});
+const controllers = {
+  controller
+};
+const middlewares = {};
+const policies = {};
+const admin = {
+  type: "admin",
+  routes: [
+    {
+      method: "GET",
+      path: "/last-opened/:uid/:documentId",
+      handler: "controller.lastOpened",
+      config: {
+        policies: []
+      }
+    }
+  ]
+};
+const routes = {
+  admin
+};
+const service = ({ strapi }) => ({
+  /**
+   * Fetches the last-opened fields for a specific document within a content type.
+   *
+   * @param uid - The unique identifier of the content type (e.g. 'api::products.products').
+   * @param documentId - The ID of the document to fetch.
+   * @param locale - The current locale of the content type / `undefined` if localization is turned off.
+   */
+  fetchLastOpened: async ({
+    uid,
+    documentId,
+    locale
+  }) => {
+    return await strapi.documents(uid).findOne({
+      documentId,
+      fields: ["openedAt", "openedBy"],
+      locale
+    });
+  },
+  /**
+   * Updates the last-opened fields for a specific document within a content type.
+   *
+   * @param uid - The unique identifier of the content type (e.g. 'api::products.products').
+   * @param documentId - The ID of the document to update.
+   * @param locale - The current locale of the content type / `undefined` if localization is turned off.
+   * @param openedAt - The date and time when the document was last opened.
+   * @param openedBy - The name of the user who last opened the document.
+   */
+  async updateLastOpened({
+    uid,
+    documentId,
+    locale,
+    openedAt,
+    openedBy
+  }) {
+    const tableName = strapi.getModel(uid).collectionName;
+    if (!tableName) {
+      throw new Error(
+        `Expected to have a collection name for the content type "${uid}" at this point.`
+      );
+    }
+    return await strapi.db.connection(tableName).update({
+      opened_at: openedAt,
+      opened_by: openedBy
+    }).where({
+      document_id: documentId,
+      // We explicitly need to provide `null` here, cause in the database
+      // the locale is stored as `NULL` when localization is turned off.
+      // Without this fallback, the query would not match any rows.
+      locale: locale || null
+    });
+  }
+});
+const services = {
+  service
+};
+const index = {
+  register,
+  bootstrap,
+  destroy,
+  config,
+  controllers,
+  routes,
+  services,
+  contentTypes,
+  policies,
+  middlewares
+};
+export {
+  index as default
+};

package/dist/server/src/bootstrap.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const bootstrap: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default bootstrap;

package/dist/server/src/config/index.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    default: {};
+    validator(): void;
+};
+export default _default;

package/dist/server/src/content-types/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/controllers/controller.d.ts

@@ -0,0 +1,12 @@
+import type { Core } from '@strapi/strapi';
+import type { Context } from 'koa';
+declare const controller: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    /**
+     * Controller method for the route that fetches and updates the last-opened fields
+     * of a document with the given `uid` and `documentId` path parameters (GET request).
+     */
+    lastOpened(ctx: Context): Promise<void>;
+};
+export default controller;

package/dist/server/src/controllers/index.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="koa" />
+declare const _default: {
+    controller: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        lastOpened(ctx: import("koa").Context): Promise<void>;
+    };
+};
+export default _default;

package/dist/server/src/destroy.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const destroy: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default destroy;

package/dist/server/src/index.d.ts

@@ -0,0 +1,58 @@
+/// <reference types="koa" />
+declare const _default: {
+    register: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    bootstrap: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    destroy: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    config: {
+        default: {};
+        validator(): void;
+    };
+    controllers: {
+        controller: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            lastOpened(ctx: import("koa").Context): Promise<void>;
+        };
+    };
+    routes: {
+        admin: {
+            type: string;
+            routes: {
+                method: string;
+                path: string;
+                handler: string;
+                config: {
+                    policies: any[];
+                };
+            }[];
+        };
+    };
+    services: {
+        service: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            fetchLastOpened: ({ uid, documentId, locale, }: {
+                uid: import("@strapi/types/dist/uid").ContentType;
+                documentId: string;
+                locale: any;
+            }) => Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            updateLastOpened({ uid, documentId, locale, openedAt, openedBy, }: {
+                uid: import("@strapi/types/dist/uid").ContentType;
+                documentId: string;
+                locale: any;
+                openedAt: string;
+                openedBy: string;
+            }): Promise<number>;
+        };
+    };
+    contentTypes: {};
+    policies: {};
+    middlewares: {};
+};
+export default _default;

package/dist/server/src/middlewares/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/policies/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/register.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const register: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default register;

package/dist/server/src/routes/admin.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    type: string;
+    routes: {
+        method: string;
+        path: string;
+        handler: string;
+        config: {
+            policies: any[];
+        };
+    }[];
+};
+export default _default;

package/dist/server/src/routes/index.d.ts

@@ -0,0 +1,14 @@
+declare const routes: {
+    admin: {
+        type: string;
+        routes: {
+            method: string;
+            path: string;
+            handler: string;
+            config: {
+                policies: any[];
+            };
+        }[];
+    };
+};
+export default routes;

package/dist/server/src/services/index.d.ts

@@ -0,0 +1,19 @@
+declare const _default: {
+    service: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        fetchLastOpened: ({ uid, documentId, locale, }: {
+            uid: import("@strapi/types/dist/uid").ContentType;
+            documentId: string;
+            locale: any;
+        }) => Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        updateLastOpened({ uid, documentId, locale, openedAt, openedBy, }: {
+            uid: import("@strapi/types/dist/uid").ContentType;
+            documentId: string;
+            locale: any;
+            openedAt: string;
+            openedBy: string;
+        }): Promise<number>;
+    };
+};
+export default _default;

package/dist/server/src/services/service.d.ts

@@ -0,0 +1,35 @@
+import type { Core } from '@strapi/strapi';
+import type { ContentTypeUID, DocumentID, Locale } from '../types';
+declare const service: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    /**
+     * Fetches the last-opened fields for a specific document within a content type.
+     *
+     * @param uid - The unique identifier of the content type (e.g. 'api::products.products').
+     * @param documentId - The ID of the document to fetch.
+     * @param locale - The current locale of the content type / `undefined` if localization is turned off.
+     */
+    fetchLastOpened: ({ uid, documentId, locale, }: {
+        uid: ContentTypeUID;
+        documentId: DocumentID;
+        locale: Locale | undefined;
+    }) => Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    /**
+     * Updates the last-opened fields for a specific document within a content type.
+     *
+     * @param uid - The unique identifier of the content type (e.g. 'api::products.products').
+     * @param documentId - The ID of the document to update.
+     * @param locale - The current locale of the content type / `undefined` if localization is turned off.
+     * @param openedAt - The date and time when the document was last opened.
+     * @param openedBy - The name of the user who last opened the document.
+     */
+    updateLastOpened({ uid, documentId, locale, openedAt, openedBy, }: {
+        uid: ContentTypeUID;
+        documentId: DocumentID;
+        locale: Locale | undefined;
+        openedAt: string;
+        openedBy: string;
+    }): Promise<number>;
+};
+export default service;

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "strapi-plugin-document-metadata",
+  "version": "1.0.1",
+  "description": "Displays entity metadata, with an option to include \"last opened\" details.",
+  "keywords": [
+    "strapi",
+    "plugin",
+    "document",
+    "metadata",
+    "last",
+    "opened",
+    "date",
+    "user"
+  ],
+  "license": "MIT",
+  "author": "Felix M. <me@felix.hamburg>",
+  "type": "commonjs",
+  "exports": {
+    "./package.json": "./package.json",
+    "./strapi-admin": {
+      "types": "./dist/admin/src/index.d.ts",
+      "source": "./admin/src/index.ts",
+      "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/src/index.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "strapi-plugin build",
+    "test:ts:back": "run -T tsc -p server/tsconfig.json",
+    "test:ts:front": "run -T tsc -p admin/tsconfig.json",
+    "verify": "strapi-plugin verify",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link"
+  },
+  "dependencies": {
+    "@strapi/design-system": "^2.1.0",
+    "@strapi/icons": "^2.1.0",
+    "react-intl": "^7.1.14"
+  },
+  "devDependencies": {
+    "@strapi/sdk-plugin": "^5.4.0",
+    "@strapi/strapi": "^5.33.2",
+    "@strapi/typescript-utils": "^5.31.0",
+    "@types/react": "^19.2.8",
+    "@types/react-dom": "^19.2.3",
+    "prettier": "^3.7.4",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.30.3",
+    "styled-components": "^6.3.5",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@strapi/sdk-plugin": "^5.3.2",
+    "@strapi/strapi": "^5.31.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.30.2",
+    "styled-components": "^6.1.19"
+  },
+  "strapi": {
+    "kind": "plugin",
+    "name": "document-metadata",
+    "displayName": "Document Metadata",
+    "description": "Displays entity metadata, with an option to include \"last opened\" details."
+  }
+}