@anchan828/nest-cloud-run-queue-pubsub-publisher 1.0.3-next.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 anchan828
+
+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,49 @@
+# @anchan828/nest-cloud-run-queue-pubsub-publisher
+
+## Install
+
+```shell
+npm i @anchan828/nest-cloud-run-queue-pubsub-publisher
+```
+
+## Usage
+
+NOTE: You may want to do tutorial for using Pub/Sub with Cloud Run before using them.
+https://cloud.google.com/run/docs/tutorials/pubsub
+
+### Import publisher module
+
+```ts
+@Module({
+  imports: [
+    PubSubPublisherModule.register({
+      topic: "myRunTopic",
+      clientConfig: {
+        // If necessary
+        projectId: "projectId",
+        keyFilename: "path/to/file.json",
+      },
+    }),
+  ],
+})
+export class PublisherAppModule {}
+```
+
+### Publish message to topic
+
+```ts
+export class Service {
+  constructor(private readonly pubsubService: PubSubPublisherService) {}
+
+  public async publishMessage(): Promise<void> {
+    await this.pubsubService.publish({
+      // Required. this property is used by @anchan828/nest-cloud-run-queue-worker
+      name: "Worker name",
+      // string or object. ex, { text: "text" }
+      data: "text",
+    });
+  }
+}
+```
+
+See more information: [https://github.com/anchan828/nest-cloud-run-queue#readme](https://github.com/anchan828/nest-cloud-run-queue#readme)

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const PUBSUB_PUBLISHER_MODULE_OPTIONS = "PUBSUB_PUBLISHER_MODULE_OPTIONS";
+export declare const PUBSUB = "PUBSUB";
+export declare const ERROR_TOPIC_NOT_FOUND = "Topic not found. Please set topic name.";

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_TOPIC_NOT_FOUND = exports.PUBSUB = exports.PUBSUB_PUBLISHER_MODULE_OPTIONS = void 0;
+exports.PUBSUB_PUBLISHER_MODULE_OPTIONS = "PUBSUB_PUBLISHER_MODULE_OPTIONS";
+exports.PUBSUB = "PUBSUB";
+exports.ERROR_TOPIC_NOT_FOUND = "Topic not found. Please set topic name.";

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { PUBSUB, PUBSUB_PUBLISHER_MODULE_OPTIONS } from "./constants";
+export { PubSubPublisherModuleAsyncOptions, PubSubPublisherModuleOptions, PubSubPublisherModuleOptionsFactory, PublishData, } from "./interfaces";
+export { PubSubPublisherModule } from "./publish.module";
+export { PubSubPublisherService } from "./publish.service";

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubPublisherService = exports.PubSubPublisherModule = exports.PUBSUB_PUBLISHER_MODULE_OPTIONS = exports.PUBSUB = void 0;
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "PUBSUB", { enumerable: true, get: function () { return constants_1.PUBSUB; } });
+Object.defineProperty(exports, "PUBSUB_PUBLISHER_MODULE_OPTIONS", { enumerable: true, get: function () { return constants_1.PUBSUB_PUBLISHER_MODULE_OPTIONS; } });
+var publish_module_1 = require("./publish.module");
+Object.defineProperty(exports, "PubSubPublisherModule", { enumerable: true, get: function () { return publish_module_1.PubSubPublisherModule; } });
+var publish_service_1 = require("./publish.service");
+Object.defineProperty(exports, "PubSubPublisherService", { enumerable: true, get: function () { return publish_service_1.PubSubPublisherService; } });

package/dist/interfaces.d.ts

@@ -0,0 +1,15 @@
+import { Message, ModuleAsyncOptions, ModuleOptions, ModuleOptionsFactory, PublishExtraConfig } from "@anchan828/nest-cloud-run-queue-common";
+import { Attributes } from "@google-cloud/pubsub";
+import { ClientConfig } from "@google-cloud/pubsub/build/src/pubsub";
+import { PublishOptions } from "@google-cloud/pubsub/build/src/topic";
+export interface PubSubPublisherModuleOptions extends ModuleOptions {
+    topic?: string;
+    clientConfig?: ClientConfig;
+    publishConfig?: PublishOptions;
+    extraConfig?: PublishExtraConfig<PublishData<any>>;
+}
+export declare type PubSubPublisherModuleAsyncOptions = ModuleAsyncOptions<PubSubPublisherModuleOptions>;
+export declare type PubSubPublisherModuleOptionsFactory = ModuleOptionsFactory<PubSubPublisherModuleOptions>;
+export interface PublishData<T> extends Message<T> {
+    attributes?: Attributes;
+}

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/providers.d.ts

@@ -0,0 +1,3 @@
+import { PubSub } from "@google-cloud/pubsub";
+import { PubSubPublisherModuleOptions } from "./interfaces";
+export declare function createPubSub(options: PubSubPublisherModuleOptions): PubSub;

package/dist/providers.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPubSub = void 0;
+const pubsub_1 = require("@google-cloud/pubsub");
+function createPubSub(options) {
+    return new pubsub_1.PubSub(options.clientConfig);
+}
+exports.createPubSub = createPubSub;

package/dist/publish.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from "@nestjs/common";
+import { PubSubPublisherModuleAsyncOptions, PubSubPublisherModuleOptions } from "./interfaces";
+export declare class PubSubPublisherModule {
+    static register(options?: PubSubPublisherModuleOptions): DynamicModule;
+    static registerAsync(options: PubSubPublisherModuleAsyncOptions): DynamicModule;
+}

package/dist/publish.module.js

@@ -0,0 +1,53 @@
+"use strict";
+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 PubSubPublisherModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubPublisherModule = void 0;
+const nest_cloud_run_queue_common_1 = require("@anchan828/nest-cloud-run-queue-common");
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+const providers_1 = require("./providers");
+const publish_service_1 = require("./publish.service");
+let PubSubPublisherModule = PubSubPublisherModule_1 = class PubSubPublisherModule {
+    static register(options = {}) {
+        const providers = [
+            (0, nest_cloud_run_queue_common_1.createOptionProvider)(constants_1.PUBSUB_PUBLISHER_MODULE_OPTIONS, options),
+            publish_service_1.PubSubPublisherService,
+            { provide: constants_1.PUBSUB, useValue: (0, providers_1.createPubSub)(options) },
+        ];
+        return {
+            exports: providers,
+            global: true,
+            module: PubSubPublisherModule_1,
+            providers,
+        };
+    }
+    static registerAsync(options) {
+        const asyncProviders = [
+            ...(0, nest_cloud_run_queue_common_1.createAsyncProviders)(constants_1.PUBSUB_PUBLISHER_MODULE_OPTIONS, options),
+            publish_service_1.PubSubPublisherService,
+            {
+                inject: [constants_1.PUBSUB_PUBLISHER_MODULE_OPTIONS],
+                provide: constants_1.PUBSUB,
+                useFactory: (options) => (0, providers_1.createPubSub)(options),
+            },
+        ];
+        const providers = [...asyncProviders];
+        return {
+            exports: providers,
+            global: true,
+            imports: [...(options.imports || [])],
+            module: PubSubPublisherModule_1,
+            providers,
+        };
+    }
+};
+PubSubPublisherModule = PubSubPublisherModule_1 = __decorate([
+    (0, common_1.Module)({})
+], PubSubPublisherModule);
+exports.PubSubPublisherModule = PubSubPublisherModule;

package/dist/publish.service.d.ts

@@ -0,0 +1,12 @@
+import { PubSub } from "@google-cloud/pubsub";
+import { PublishOptions } from "@google-cloud/pubsub/build/src/topic";
+import { PubSubPublisherModuleOptions, PublishData } from "./interfaces";
+export declare class PubSubPublisherService {
+    private readonly options;
+    private readonly pubsub;
+    constructor(options: PubSubPublisherModuleOptions, pubsub: PubSub);
+    publish<T>(message: PublishData<T>, options?: PublishOptions & {
+        topic?: string;
+    }): Promise<string>;
+    private getTopicName;
+}

package/dist/publish.service.js

@@ -0,0 +1,73 @@
+"use strict";
+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); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubPublisherService = void 0;
+const pubsub_1 = require("@google-cloud/pubsub");
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+let PubSubPublisherService = class PubSubPublisherService {
+    constructor(options, pubsub) {
+        this.options = options;
+        this.pubsub = pubsub;
+    }
+    publish(message, options) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const topicName = this.getTopicName(options);
+            const topic = this.pubsub.topic(topicName, Object.assign({}, this.options.publishConfig, options));
+            const _e = ((_a = this.options.extraConfig) === null || _a === void 0 ? void 0 : _a.prePublish)
+                ? yield ((_b = this.options.extraConfig) === null || _b === void 0 ? void 0 : _b.prePublish(message))
+                : message, { attributes } = _e, json = __rest(_e, ["attributes"]);
+            const messageId = yield topic.publishMessage({ attributes, json });
+            if ((_c = this.options.extraConfig) === null || _c === void 0 ? void 0 : _c.postPublish) {
+                yield ((_d = this.options.extraConfig) === null || _d === void 0 ? void 0 : _d.postPublish(message, messageId));
+            }
+            return messageId;
+        });
+    }
+    getTopicName(options) {
+        const topic = this.options.topic || (options === null || options === void 0 ? void 0 : options.topic);
+        if (!topic) {
+            throw new Error(constants_1.ERROR_TOPIC_NOT_FOUND);
+        }
+        return topic;
+    }
+};
+PubSubPublisherService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(constants_1.PUBSUB_PUBLISHER_MODULE_OPTIONS)),
+    __param(1, (0, common_1.Inject)(constants_1.PUBSUB)),
+    __metadata("design:paramtypes", [Object, pubsub_1.PubSub])
+], PubSubPublisherService);
+exports.PubSubPublisherService = PubSubPublisherService;

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@anchan828/nest-cloud-run-queue-pubsub-publisher",
+  "version": "1.0.3-next.0",
+  "description": "> TODO: description",
+  "homepage": "https://github.com/anchan828/nest-cloud-run-queue/tree/master/packages/pubsub-publish#readme",
+  "bugs": {
+    "url": "https://github.com/anchan828/nest-cloud-run-queue/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anchan828/nest-cloud-run-queue.git"
+  },
+  "license": "MIT",
+  "author": "anchan828 <anchan828@gmail.com>",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "directories": {
+    "dist": "dist"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:watch": "tsc --watch",
+    "copy:license": "cp ../../LICENSE ./",
+    "lint": "eslint --ignore-path ../../.eslintignore '**/*.ts'",
+    "lint:fix": "npm run lint -- --fix",
+    "prepublishOnly": "rm -rf dist && npm run build && rm -f dist/*.tsbuildinfo && npm run copy:license",
+    "test": "jest --coverage --logHeapUsage --runInBand",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --logHeapUsage",
+    "test:watch": "jest --watch",
+    "watch": "tsc -w"
+  },
+  "dependencies": {
+    "@anchan828/nest-cloud-run-queue-common": "^1.0.3-next.0",
+    "@google-cloud/pubsub": "2.19.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "8.4.4",
+    "rxjs": "7.5.5"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^8.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "470341e04eead0d62396245ff1a3fe0c7ad4143e"
+}