@nocobase/plugin-notification-in-app-message 2.2.0-beta.1 → 2.2.0-beta.10

package/dist/swagger/index.js

@@ -0,0 +1,375 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+const jsonObjectSchema = {
+  type: "object",
+  additionalProperties: true
+};
+const listParameters = [
+  {
+    name: "filter",
+    in: "query",
+    required: false,
+    description: "Filter object encoded as JSON.",
+    schema: jsonObjectSchema
+  },
+  {
+    name: "page",
+    in: "query",
+    required: false,
+    schema: {
+      type: "integer"
+    }
+  },
+  {
+    name: "pageSize",
+    in: "query",
+    required: false,
+    schema: {
+      type: "integer"
+    }
+  }
+];
+const myInAppChannelListParameters = [
+  {
+    name: "filter",
+    in: "query",
+    required: false,
+    description: "Filter object encoded as JSON. Supports `status`, `name`, and `latestMsgReceiveTimestamp.$lt` for cursor-like pagination.",
+    schema: jsonObjectSchema
+  },
+  {
+    name: "limit",
+    in: "query",
+    required: false,
+    schema: {
+      type: "integer",
+      default: 30
+    }
+  }
+];
+const userIdSchema = {
+  oneOf: [
+    {
+      type: "string",
+      description: "User id serialized as a string. This is common for bigInt identifiers."
+    },
+    {
+      type: "integer",
+      description: "User id when the runtime serializes the value as a JSON number."
+    }
+  ]
+};
+var swagger_default = {
+  openapi: "3.0.2",
+  info: {
+    title: "NocoBase API - Notification in-app message plugin"
+  },
+  paths: {
+    "/myInAppMessages:list": {
+      get: {
+        tags: ["myInAppMessages"],
+        summary: "List current user in-app messages",
+        description: "List messages for the current user. The server always scopes results to `ctx.state.currentUser.id`.",
+        parameters: listParameters,
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/MyInAppMessagesResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/myInAppMessages:count": {
+      get: {
+        tags: ["myInAppMessages"],
+        summary: "Count current user unread in-app messages",
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    count: {
+                      type: "integer"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/myInAppChannels:list": {
+      get: {
+        tags: ["myInAppChannels"],
+        summary: "List current user in-app message channels",
+        description: "List channels that have messages for the current user, including unread counts and latest message metadata.",
+        parameters: myInAppChannelListParameters,
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/MyInAppChannelsResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/notificationInAppMessages:list": {
+      get: {
+        tags: ["notificationInAppMessages"],
+        summary: "List in-app message records",
+        parameters: listParameters,
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      type: "array",
+                      items: {
+                        $ref: "#/components/schemas/InAppMessage"
+                      }
+                    },
+                    meta: jsonObjectSchema
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/notificationInAppMessages:get": {
+      get: {
+        tags: ["notificationInAppMessages"],
+        summary: "Get one in-app message record",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: true,
+            description: "In-app message UUID.",
+            schema: {
+              type: "string",
+              format: "uuid"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      $ref: "#/components/schemas/InAppMessage"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/notificationInAppMessages:updateMyOwn": {
+      post: {
+        tags: ["notificationInAppMessages"],
+        summary: "Update current user own in-app message",
+        description: "Update only the current user own message. The action merges `filter.userId` from the current user and whitelists `status`.",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: false,
+            description: "In-app message UUID.",
+            schema: {
+              type: "string",
+              format: "uuid"
+            }
+          },
+          {
+            name: "filter",
+            in: "query",
+            required: false,
+            schema: jsonObjectSchema
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                required: ["status"],
+                properties: {
+                  status: {
+                    type: "string",
+                    enum: ["read", "unread"]
+                  }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      $ref: "#/components/schemas/InAppMessage"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      InAppMessage: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            format: "uuid"
+          },
+          userId: {
+            ...userIdSchema
+          },
+          channelName: {
+            type: "string"
+          },
+          title: {
+            type: "string"
+          },
+          content: {
+            type: "string"
+          },
+          status: {
+            type: "string",
+            enum: ["read", "unread"]
+          },
+          receiveTimestamp: {
+            type: "integer",
+            format: "int64"
+          },
+          options: jsonObjectSchema,
+          createdAt: {
+            type: "string",
+            format: "date-time"
+          }
+        },
+        additionalProperties: true
+      },
+      MyInAppMessagesResponse: {
+        type: "object",
+        properties: {
+          messages: {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/InAppMessage"
+            }
+          }
+        }
+      },
+      MyInAppChannel: {
+        type: "object",
+        properties: {
+          name: {
+            type: "string"
+          },
+          title: {
+            type: "string"
+          },
+          userId: {
+            ...userIdSchema
+          },
+          unreadMsgCnt: {
+            type: "integer"
+          },
+          totalMsgCnt: {
+            type: "integer"
+          },
+          latestMsgReceiveTimestamp: {
+            type: "integer",
+            format: "int64"
+          },
+          latestMsgTitle: {
+            type: "string"
+          }
+        },
+        additionalProperties: true
+      },
+      MyInAppChannelsResponse: {
+        type: "object",
+        properties: {
+          rows: {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/MyInAppChannel"
+            }
+          },
+          count: {
+            type: "integer"
+          }
+        }
+      }
+    }
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/plugin-notification-in-app-message",
-  "version": "2.2.0-beta.1",
+  "version": "2.2.0-beta.10",
   "displayName": "Notification: In-app message",
   "displayName.ru-RU": "Уведомления: Всплывающие сообщения внутри приложения",
   "displayName.zh-CN": "通知：站内信",
@@ -33,5 +33,5 @@
     "react-router-dom": "^6.x"
   },
   "license": "Apache-2.0",
-  "gitHead": "f82fa9d0c3aa8e00e53dd94e404a312483b4866b"
+  "gitHead": "d572beec24de46df948f28db72b25303a63bf62d"
 }