@shankarkharel/profanity-nest 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,98 @@
1
+ <p align="center">
2
+ <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
3
+ </p>
4
+
5
+ [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6
+ [circleci-url]: https://circleci.com/gh/nestjs/nest
7
+
8
+ <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
9
+ <p align="center">
10
+ <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11
+ <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12
+ <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13
+ <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
14
+ <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
15
+ <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
16
+ <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
17
+ <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
18
+ <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
19
+ <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
20
+ </p>
21
+ <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
22
+ [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
23
+
24
+ ## Description
25
+
26
+ [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
27
+
28
+ ## Project setup
29
+
30
+ ```bash
31
+ $ yarn install
32
+ ```
33
+
34
+ ## Compile and run the project
35
+
36
+ ```bash
37
+ # development
38
+ $ yarn run start
39
+
40
+ # watch mode
41
+ $ yarn run start:dev
42
+
43
+ # production mode
44
+ $ yarn run start:prod
45
+ ```
46
+
47
+ ## Run tests
48
+
49
+ ```bash
50
+ # unit tests
51
+ $ yarn run test
52
+
53
+ # e2e tests
54
+ $ yarn run test:e2e
55
+
56
+ # test coverage
57
+ $ yarn run test:cov
58
+ ```
59
+
60
+ ## Deployment
61
+
62
+ When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
63
+
64
+ If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
65
+
66
+ ```bash
67
+ $ yarn install -g @nestjs/mau
68
+ $ mau deploy
69
+ ```
70
+
71
+ With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
72
+
73
+ ## Resources
74
+
75
+ Check out a few resources that may come in handy when working with NestJS:
76
+
77
+ - Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
78
+ - For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
79
+ - To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
80
+ - Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
81
+ - Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
82
+ - Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
83
+ - To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
84
+ - Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
85
+
86
+ ## Support
87
+
88
+ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
89
+
90
+ ## Stay in touch
91
+
92
+ - Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
93
+ - Website - [https://nestjs.com](https://nestjs.com/)
94
+ - Twitter - [@nestframework](https://twitter.com/nestframework)
95
+
96
+ ## License
97
+
98
+ Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
@@ -0,0 +1,25 @@
1
+ import { DynamicModule } from '@nestjs/common';
2
+ import * as _shankarkharel_profanity_core from '@shankarkharel/profanity-core';
3
+ import { EngineOptions, LanguagePack, ProfanityEngine } from '@shankarkharel/profanity-core';
4
+
5
+ interface ProfanityModuleOptions extends EngineOptions {
6
+ packs: LanguagePack[];
7
+ }
8
+
9
+ declare class ProfanityModule {
10
+ static forRoot(options: ProfanityModuleOptions): DynamicModule;
11
+ }
12
+
13
+ declare class ProfanityService {
14
+ private readonly engine;
15
+ constructor(engine: ProfanityEngine);
16
+ analyze(text: string): _shankarkharel_profanity_core.AnalyzeResult;
17
+ isProfane(text: string): boolean;
18
+ censor(text: string, opts?: {
19
+ censorChar?: string;
20
+ preserveFirstLast?: boolean;
21
+ replaceWith?: string;
22
+ }): string;
23
+ }
24
+
25
+ export { ProfanityModule, type ProfanityModuleOptions, ProfanityService };
@@ -0,0 +1,25 @@
1
+ import { DynamicModule } from '@nestjs/common';
2
+ import * as _shankarkharel_profanity_core from '@shankarkharel/profanity-core';
3
+ import { EngineOptions, LanguagePack, ProfanityEngine } from '@shankarkharel/profanity-core';
4
+
5
+ interface ProfanityModuleOptions extends EngineOptions {
6
+ packs: LanguagePack[];
7
+ }
8
+
9
+ declare class ProfanityModule {
10
+ static forRoot(options: ProfanityModuleOptions): DynamicModule;
11
+ }
12
+
13
+ declare class ProfanityService {
14
+ private readonly engine;
15
+ constructor(engine: ProfanityEngine);
16
+ analyze(text: string): _shankarkharel_profanity_core.AnalyzeResult;
17
+ isProfane(text: string): boolean;
18
+ censor(text: string, opts?: {
19
+ censorChar?: string;
20
+ preserveFirstLast?: boolean;
21
+ replaceWith?: string;
22
+ }): string;
23
+ }
24
+
25
+ export { ProfanityModule, type ProfanityModuleOptions, ProfanityService };
package/dist/index.js ADDED
@@ -0,0 +1,124 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
7
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
8
+ var __export = (target, all) => {
9
+ for (var name in all)
10
+ __defProp(target, name, { get: all[name], enumerable: true });
11
+ };
12
+ var __copyProps = (to, from, except, desc) => {
13
+ if (from && typeof from === "object" || typeof from === "function") {
14
+ for (let key of __getOwnPropNames(from))
15
+ if (!__hasOwnProp.call(to, key) && key !== except)
16
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
+ }
18
+ return to;
19
+ };
20
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
21
+ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
22
+
23
+ // src/index.ts
24
+ var index_exports = {};
25
+ __export(index_exports, {
26
+ ProfanityModule: () => ProfanityModule,
27
+ ProfanityService: () => ProfanityService
28
+ });
29
+ module.exports = __toCommonJS(index_exports);
30
+
31
+ // src/profanity.module.ts
32
+ var import_common2 = require("@nestjs/common");
33
+ var import_profanity_core = require("@shankarkharel/profanity-core");
34
+
35
+ // src/constants.ts
36
+ var PROFANITY_OPTIONS = /* @__PURE__ */ Symbol("PROFANITY_OPTIONS");
37
+ var PROFANITY_ENGINE = /* @__PURE__ */ Symbol("PROFANITY_ENGINE");
38
+
39
+ // src/profanity.service.ts
40
+ var import_common = require("@nestjs/common");
41
+ function _ts_decorate(decorators, target, key, desc) {
42
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
43
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
44
+ 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;
45
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
46
+ }
47
+ __name(_ts_decorate, "_ts_decorate");
48
+ function _ts_metadata(k, v) {
49
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
50
+ }
51
+ __name(_ts_metadata, "_ts_metadata");
52
+ function _ts_param(paramIndex, decorator) {
53
+ return function(target, key) {
54
+ decorator(target, key, paramIndex);
55
+ };
56
+ }
57
+ __name(_ts_param, "_ts_param");
58
+ var _ProfanityService = class _ProfanityService {
59
+ constructor(engine) {
60
+ __publicField(this, "engine");
61
+ this.engine = engine;
62
+ }
63
+ analyze(text) {
64
+ return this.engine.analyze(text);
65
+ }
66
+ isProfane(text) {
67
+ return this.engine.isProfane(text);
68
+ }
69
+ censor(text, opts) {
70
+ return this.engine.censor(text, opts);
71
+ }
72
+ };
73
+ __name(_ProfanityService, "ProfanityService");
74
+ var ProfanityService = _ProfanityService;
75
+ ProfanityService = _ts_decorate([
76
+ (0, import_common.Injectable)(),
77
+ _ts_param(0, (0, import_common.Inject)(PROFANITY_ENGINE)),
78
+ _ts_metadata("design:type", Function),
79
+ _ts_metadata("design:paramtypes", [
80
+ typeof ProfanityEngine === "undefined" ? Object : ProfanityEngine
81
+ ])
82
+ ], ProfanityService);
83
+
84
+ // src/profanity.module.ts
85
+ function _ts_decorate2(decorators, target, key, desc) {
86
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
87
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
88
+ 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;
89
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
90
+ }
91
+ __name(_ts_decorate2, "_ts_decorate");
92
+ var _ProfanityModule = class _ProfanityModule {
93
+ static forRoot(options) {
94
+ const optionsProvider = {
95
+ provide: PROFANITY_OPTIONS,
96
+ useValue: options
97
+ };
98
+ const engineProvider = {
99
+ provide: PROFANITY_ENGINE,
100
+ useFactory: /* @__PURE__ */ __name(() => new import_profanity_core.ProfanityEngine(options.packs, options), "useFactory")
101
+ };
102
+ return {
103
+ module: _ProfanityModule,
104
+ providers: [
105
+ optionsProvider,
106
+ engineProvider,
107
+ ProfanityService
108
+ ],
109
+ exports: [
110
+ ProfanityService
111
+ ]
112
+ };
113
+ }
114
+ };
115
+ __name(_ProfanityModule, "ProfanityModule");
116
+ var ProfanityModule = _ProfanityModule;
117
+ ProfanityModule = _ts_decorate2([
118
+ (0, import_common2.Module)({})
119
+ ], ProfanityModule);
120
+ // Annotate the CommonJS export names for ESM import in node:
121
+ 0 && (module.exports = {
122
+ ProfanityModule,
123
+ ProfanityService
124
+ });
package/dist/index.mjs ADDED
@@ -0,0 +1,98 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
3
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
4
+ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
5
+
6
+ // src/profanity.module.ts
7
+ import { Module } from "@nestjs/common";
8
+ import { ProfanityEngine as ProfanityEngine2 } from "@shankarkharel/profanity-core";
9
+
10
+ // src/constants.ts
11
+ var PROFANITY_OPTIONS = /* @__PURE__ */ Symbol("PROFANITY_OPTIONS");
12
+ var PROFANITY_ENGINE = /* @__PURE__ */ Symbol("PROFANITY_ENGINE");
13
+
14
+ // src/profanity.service.ts
15
+ import { Inject, Injectable } from "@nestjs/common";
16
+ function _ts_decorate(decorators, target, key, desc) {
17
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
18
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
19
+ 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;
20
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
21
+ }
22
+ __name(_ts_decorate, "_ts_decorate");
23
+ function _ts_metadata(k, v) {
24
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
+ }
26
+ __name(_ts_metadata, "_ts_metadata");
27
+ function _ts_param(paramIndex, decorator) {
28
+ return function(target, key) {
29
+ decorator(target, key, paramIndex);
30
+ };
31
+ }
32
+ __name(_ts_param, "_ts_param");
33
+ var _ProfanityService = class _ProfanityService {
34
+ constructor(engine) {
35
+ __publicField(this, "engine");
36
+ this.engine = engine;
37
+ }
38
+ analyze(text) {
39
+ return this.engine.analyze(text);
40
+ }
41
+ isProfane(text) {
42
+ return this.engine.isProfane(text);
43
+ }
44
+ censor(text, opts) {
45
+ return this.engine.censor(text, opts);
46
+ }
47
+ };
48
+ __name(_ProfanityService, "ProfanityService");
49
+ var ProfanityService = _ProfanityService;
50
+ ProfanityService = _ts_decorate([
51
+ Injectable(),
52
+ _ts_param(0, Inject(PROFANITY_ENGINE)),
53
+ _ts_metadata("design:type", Function),
54
+ _ts_metadata("design:paramtypes", [
55
+ typeof ProfanityEngine === "undefined" ? Object : ProfanityEngine
56
+ ])
57
+ ], ProfanityService);
58
+
59
+ // src/profanity.module.ts
60
+ function _ts_decorate2(decorators, target, key, desc) {
61
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
62
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
63
+ 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;
64
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
65
+ }
66
+ __name(_ts_decorate2, "_ts_decorate");
67
+ var _ProfanityModule = class _ProfanityModule {
68
+ static forRoot(options) {
69
+ const optionsProvider = {
70
+ provide: PROFANITY_OPTIONS,
71
+ useValue: options
72
+ };
73
+ const engineProvider = {
74
+ provide: PROFANITY_ENGINE,
75
+ useFactory: /* @__PURE__ */ __name(() => new ProfanityEngine2(options.packs, options), "useFactory")
76
+ };
77
+ return {
78
+ module: _ProfanityModule,
79
+ providers: [
80
+ optionsProvider,
81
+ engineProvider,
82
+ ProfanityService
83
+ ],
84
+ exports: [
85
+ ProfanityService
86
+ ]
87
+ };
88
+ }
89
+ };
90
+ __name(_ProfanityModule, "ProfanityModule");
91
+ var ProfanityModule = _ProfanityModule;
92
+ ProfanityModule = _ts_decorate2([
93
+ Module({})
94
+ ], ProfanityModule);
95
+ export {
96
+ ProfanityModule,
97
+ ProfanityService
98
+ };
package/package.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "@shankarkharel/profanity-nest",
3
+ "version": "1.0.0",
4
+ "description": "NestJS module for @your-scope/profanity-core",
5
+ "main": "dist/index.cjs",
6
+ "module": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.mjs",
12
+ "require": "./dist/index.js"
13
+ }
14
+ },
15
+ "files": [
16
+ "dist"
17
+ ],
18
+ "scripts": {
19
+ "build": "tsup src/index.ts --format cjs,esm --dts --clean",
20
+ "test": "echo \"(add tests later)\"",
21
+ "lint": "echo \"(add eslint later)\""
22
+ },
23
+ "dependencies": {
24
+ "@nestjs/common": "^10.0.0",
25
+ "@shankarkharel/profanity-core": "1.0.0"
26
+ },
27
+ "peerDependencies": {
28
+ "@nestjs/common": "^9 || ^10"
29
+ },
30
+ "license": "MIT"
31
+ }