@deenruv/newsletter-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+# License 1
+
+The MIT License
+
+Copyright (c) 2025-present Aexol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# License 2
+
+The MIT License
+
+Copyright (c) 2018-2025 Michael Bromley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @deenruv/newsletter-plugin
+
+Plugin that provides newsletter subscription functionality via the Shop API. It uses a strategy-based approach, allowing you to plug in any newsletter service provider (e.g., Mailchimp, SendGrid, custom API).
+
+## Installation
+
+```bash
+pnpm add @deenruv/newsletter-plugin
+```
+
+## Configuration
+
+```typescript
+import { NewsletterPlugin, DefaultNewsletterStrategy } from '@deenruv/newsletter-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  NewsletterPlugin.init({
+    strategy: new DefaultNewsletterStrategy(),
+    // Or provide your own:
+    // strategy: new MyCustomNewsletterStrategy(),
+  }),
+]
+```
+
+### Custom Strategy
+
+```typescript
+import type { NewsletterStrategy } from '@deenruv/newsletter-plugin';
+
+class MyNewsletterStrategy implements NewsletterStrategy {
+  async addToNewsLetter(ctx, email) {
+    // Integrate with your newsletter provider
+    return { success: true };
+  }
+}
+```
+
+## Features
+
+- Strategy-based newsletter subscription architecture
+- Built-in `DefaultNewsletterStrategy` for quick setup
+- Shop API mutation for email subscription
+- Error handling with typed error codes (e.g., `InvalidEmail`)
+- Lifecycle management with automatic strategy init/destroy
+
+## Admin UI
+
+This plugin is server-only and does not add any admin UI extensions.
+
+## API Extensions
+
+### Shop API
+
+- **Mutation** `addToNewsletter(email: String!): AddToNewsletterResult!` — Subscribes an email to the newsletter. Returns either `AddToNewsletterSuccessResult` or `AddToNewsletterErrorResult` with a `NewsletterErrorCode`.

package/dist/plugin-server/api/newsletter-shop-resolver.d.ts

@@ -0,0 +1,13 @@
+import { RequestContext } from "@deenruv/core";
+import { NewsletterService } from "../services/newsletter-service.js";
+export declare class NewsletterShopResolver {
+    private newsletterService;
+    constructor(newsletterService: NewsletterService);
+    addToNewsletter(ctx: RequestContext, args: {
+        email: string;
+    }): Promise<{
+        success: boolean;
+    } | {
+        errorCode: string;
+    }>;
+}

package/dist/plugin-server/api/newsletter-shop-resolver.js

@@ -0,0 +1,36 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Args, Resolver, Mutation } from "@nestjs/graphql";
+import { Ctx, RequestContext } from "@deenruv/core";
+import { NewsletterService } from "../services/newsletter-service.js";
+let NewsletterShopResolver = class NewsletterShopResolver {
+    constructor(newsletterService) {
+        this.newsletterService = newsletterService;
+    }
+    async addToNewsletter(ctx, args) {
+        return this.newsletterService.addToNewsLetter(ctx, args.email);
+    }
+};
+__decorate([
+    Mutation(),
+    __param(0, Ctx()),
+    __param(1, Args()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], NewsletterShopResolver.prototype, "addToNewsletter", null);
+NewsletterShopResolver = __decorate([
+    Resolver(),
+    __metadata("design:paramtypes", [NewsletterService])
+], NewsletterShopResolver);
+export { NewsletterShopResolver };

package/dist/plugin-server/constants.d.ts

@@ -0,0 +1 @@
+export declare const NEWSLETTER_PLUGIN_OPTIONS: unique symbol;

package/dist/plugin-server/constants.js

@@ -0,0 +1 @@
+export const NEWSLETTER_PLUGIN_OPTIONS = Symbol("options");

package/dist/plugin-server/extensions/api-extension.d.ts

@@ -0,0 +1 @@
+export declare const shopApiExtension: import("graphql").DocumentNode;

package/dist/plugin-server/extensions/api-extension.js

@@ -0,0 +1,19 @@
+import { gql } from "graphql-tag";
+export const shopApiExtension = gql `
+  enum NewsletterErrorCode {
+    InvalidEmail
+  }
+  type AddToNewsletterSuccessResult {
+    success: Boolean!
+  }
+  type AddToNewsletterErrorResult {
+    errorCode: NewsletterErrorCode!
+  }
+  union AddToNewsletterResult =
+    | AddToNewsletterSuccessResult
+    | AddToNewsletterErrorResult
+
+  extend type Mutation {
+    addToNewsletter(email: String!): AddToNewsletterResult!
+  }
+`;

package/dist/plugin-server/index.d.ts

@@ -0,0 +1,15 @@
+import { DefaultNewsletterStrategy } from "./strategies/default-newsletter-strategy.js";
+import { NewsletterPluginOptions, NewsletterStrategy } from "./types.js";
+import { ModuleRef } from "@nestjs/core";
+import { OnApplicationBootstrap } from "@nestjs/common";
+declare class NewsletterPlugin implements OnApplicationBootstrap {
+    private moduleRef;
+    static options: NewsletterPluginOptions;
+    constructor(moduleRef: ModuleRef);
+    static init(options: NewsletterPluginOptions): typeof NewsletterPlugin;
+    onApplicationBootstrap(): Promise<void>;
+    onApplicationShutdown(): Promise<void>;
+    private initStrategy;
+    private destroyStrategy;
+}
+export { NewsletterPlugin, DefaultNewsletterStrategy, NewsletterStrategy };

package/dist/plugin-server/index.js

@@ -0,0 +1,67 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Injector, PluginCommonModule, DeenruvPlugin } from "@deenruv/core";
+import { DefaultNewsletterStrategy } from "./strategies/default-newsletter-strategy.js";
+import { ModuleRef } from "@nestjs/core";
+import { NEWSLETTER_PLUGIN_OPTIONS } from "./constants.js";
+import { NewsletterService } from "./services/newsletter-service.js";
+import { shopApiExtension } from "./extensions/api-extension.js";
+import { NewsletterShopResolver } from "./api/newsletter-shop-resolver.js";
+let NewsletterPlugin = class NewsletterPlugin {
+    constructor(moduleRef) {
+        this.moduleRef = moduleRef;
+    }
+    static init(options) {
+        this.options = options;
+        return this;
+    }
+    async onApplicationBootstrap() {
+        await this.initStrategy();
+    }
+    async onApplicationShutdown() {
+        await this.destroyStrategy();
+    }
+    async initStrategy() {
+        const injector = new Injector(this.moduleRef);
+        const service = injector.get(NewsletterService);
+        if (typeof service.strategy.init === "function") {
+            await service.strategy.init(injector);
+        }
+    }
+    async destroyStrategy() {
+        const injector = new Injector(this.moduleRef);
+        const service = injector.get(NewsletterService);
+        if (typeof service.strategy.destroy === "function") {
+            await service.strategy.destroy();
+        }
+    }
+};
+NewsletterPlugin = __decorate([
+    DeenruvPlugin({
+        compatibility: "^0.0.40",
+        imports: [PluginCommonModule],
+        providers: [
+            {
+                provide: NEWSLETTER_PLUGIN_OPTIONS,
+                useFactory: () => NewsletterPlugin.options,
+            },
+            NewsletterService,
+        ],
+        shopApiExtensions: {
+            schema: shopApiExtension,
+            resolvers: [NewsletterShopResolver],
+        },
+        configuration: (config) => {
+            return config;
+        },
+    }),
+    __metadata("design:paramtypes", [ModuleRef])
+], NewsletterPlugin);
+export { NewsletterPlugin, DefaultNewsletterStrategy };

package/dist/plugin-server/services/newsletter-service.d.ts

@@ -0,0 +1,14 @@
+import { RequestContext } from "@deenruv/core";
+import { NewsletterPluginOptions, NewsletterStrategy } from "../types.js";
+export declare class NewsletterService {
+    private readonly options;
+    strategy: NewsletterStrategy;
+    private readonly logger;
+    private log;
+    constructor(options: NewsletterPluginOptions);
+    addToNewsLetter(ctx: RequestContext, email: string): Promise<{
+        success: boolean;
+    } | {
+        errorCode: string;
+    }>;
+}

package/dist/plugin-server/services/newsletter-service.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from "@nestjs/common";
+import { Logger } from "@deenruv/core";
+import { DefaultNewsletterStrategy } from "../strategies/default-newsletter-strategy.js";
+import { NEWSLETTER_PLUGIN_OPTIONS } from "../constants.js";
+let NewsletterService = class NewsletterService {
+    constructor(options) {
+        var _a;
+        this.options = options;
+        this.logger = new Logger();
+        this.log = (message) => this.logger.log(message, "Newsletter Service");
+        this.strategy = (_a = options === null || options === void 0 ? void 0 : options.strategy) !== null && _a !== void 0 ? _a : new DefaultNewsletterStrategy();
+    }
+    async addToNewsLetter(ctx, email) {
+        const response = await this.strategy.addToNewsLetter(ctx, email);
+        return response;
+    }
+};
+NewsletterService = __decorate([
+    Injectable(),
+    __param(0, Inject(NEWSLETTER_PLUGIN_OPTIONS)),
+    __metadata("design:paramtypes", [Object])
+], NewsletterService);
+export { NewsletterService };

package/dist/plugin-server/strategies/default-newsletter-strategy.d.ts

@@ -0,0 +1,7 @@
+import { RequestContext } from "@deenruv/core";
+import { NewsletterStrategy } from "../types.js";
+export declare class DefaultNewsletterStrategy implements NewsletterStrategy {
+    addToNewsLetter(ctx: RequestContext, email: string): Promise<{
+        success: boolean;
+    }>;
+}

package/dist/plugin-server/strategies/default-newsletter-strategy.js

@@ -0,0 +1,5 @@
+export class DefaultNewsletterStrategy {
+    async addToNewsLetter(ctx, email) {
+        return { success: true };
+    }
+}

package/dist/plugin-server/types.d.ts

@@ -0,0 +1,13 @@
+import { InjectableStrategy, RequestContext } from "@deenruv/core";
+export type NewsletterPluginOptions = {
+    strategy?: NewsletterStrategy;
+};
+type NewsletterResponse = {
+    success: boolean;
+} | {
+    errorCode: string;
+};
+export interface NewsletterStrategy extends InjectableStrategy {
+    addToNewsLetter: (ctx: RequestContext, email: string) => Promise<NewsletterResponse>;
+}
+export {};

package/dist/plugin-server/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@deenruv/newsletter-plugin",
+  "version": "1.0.0",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "exports": {
+    "./plugin-server": "./dist/plugin-server/index.js"
+  },
+  "dependencies": {
+    "@nestjs/common": "~10.3.10",
+    "@nestjs/graphql": "~12.2.0",
+    "graphql": "~16.9.0",
+    "graphql-tag": "^2.12.6",
+    "graphql-zeus": "^5.4.2",
+    "@deenruv/common": "^1.0.0",
+    "@deenruv/admin-types": "^1.0.0",
+    "@deenruv/react-ui-devkit": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "rimraf": "^5.0.10",
+    "tslib": "^2.6.2",
+    "typescript": "5.3.3",
+    "@deenruv/core": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@deenruv/core": "^0.1.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc --build",
+    "watch": "concurrently -k -p \"[{name}]\" -n \"SERVER,UI\" -c \"yellow.bold,cyan.bold\" \"tsc --watch --project src/plugin-server/tsconfig.json\"",
+    "lint": "eslint ./src/**/*.ts",
+    "lint:fix": "eslint --fix ./src/**/*.ts",
+    "zeus": "zeus http://localhost:3000/admin-api ./src/plugin-server --es"
+  }
+}