@anchan828/nest-cloud-run-queue-tasks-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,55 @@
+# @anchan828/nest-cloud-run-queue-tasks-publisher
+
+## Install
+
+```shell
+npm i @anchan828/nest-cloud-run-queue-tasks-publisher
+```
+
+## Usage
+
+NOTE: You may want to do tutorial for using Tasks with Cloud Run before using them.
+https://cloud.google.com/run/docs/triggering/using-tasks
+
+### Import publisher module
+
+```ts
+@Module({
+  imports: [
+    TasksPublisherModule.register({
+      clientConfig: {
+        // If necessary
+        projectId: "projectId",
+        keyFilename: "path/to/file.json",
+      },
+      publishConfig: {
+        httpRequest: {
+          // By setting this as the default URL here, you can save yourself the trouble of setting the URL each time.
+          url: "https://example-this-is-demo-uc.a.run.app",
+        },
+      },
+      queue: "projects/test/locations/location/queues/nest-cloud-run-queue-demo",
+    }),
+  ],
+})
+export class PublisherAppModule {}
+```
+
+### Publish message to queue
+
+```ts
+export class Service {
+  constructor(private readonly tasksService: TasksPublisherService) {}
+
+  public async sendMessage(): Promise<void> {
+    await this.tasksService.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 TASKS_PUBLISHER_MODULE_OPTIONS = "TASKS_PUBLISHER_MODULE_OPTIONS";
+export declare const TASKS_CLIENT = "TASKS_CLIENT";
+export declare const ERROR_QUEUE_NOT_FOUND = "Queue not found. Please set queue name.";

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_QUEUE_NOT_FOUND = exports.TASKS_CLIENT = exports.TASKS_PUBLISHER_MODULE_OPTIONS = void 0;
+exports.TASKS_PUBLISHER_MODULE_OPTIONS = "TASKS_PUBLISHER_MODULE_OPTIONS";
+exports.TASKS_CLIENT = "TASKS_CLIENT";
+exports.ERROR_QUEUE_NOT_FOUND = "Queue not found. Please set queue name.";

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { TasksPublisherModuleAsyncOptions, TasksPublisherModuleOptions, TasksPublisherModuleOptionsFactory, PublishConfig, PublishData, PublishOptions, } from "./interfaces";
+export { TASKS_CLIENT } from "./constants";
+export { TasksPublisherModule } from "./publish.module";
+export { TasksPublisherService } from "./publish.service";

package/dist/index.js

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

package/dist/interfaces.d.ts

@@ -0,0 +1,17 @@
+import { Message, ModuleAsyncOptions, ModuleOptions, ModuleOptionsFactory, PublishExtraConfig } from "@anchan828/nest-cloud-run-queue-common";
+import type { google } from "@google-cloud/tasks/build/protos/protos";
+import { ClientOptions, CallOptions } from "google-gax";
+export interface TasksPublisherModuleOptions extends ModuleOptions {
+    queue?: string;
+    clientConfig?: ClientOptions;
+    publishConfig?: PublishConfig;
+    extraConfig?: PublishExtraConfig;
+}
+export declare type TasksPublisherModuleAsyncOptions = ModuleAsyncOptions<TasksPublisherModuleOptions>;
+export declare type TasksPublisherModuleOptionsFactory = ModuleOptionsFactory<TasksPublisherModuleOptions>;
+export declare type PublishConfig = Omit<google.cloud.tasks.v2.ITask, "name">;
+export declare type PublishOptions = {
+    queue?: string;
+    gaxOpts?: CallOptions;
+} & PublishConfig;
+export declare type PublishData<T> = Message<T>;

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 { CloudTasksClient } from "@google-cloud/tasks";
+import { TasksPublisherModuleOptions } from "./interfaces";
+export declare function createClient(options: TasksPublisherModuleOptions): CloudTasksClient;

package/dist/providers.js

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

package/dist/publish.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from "@nestjs/common";
+import { TasksPublisherModuleAsyncOptions, TasksPublisherModuleOptions } from "./interfaces";
+export declare class TasksPublisherModule {
+    static register(options?: TasksPublisherModuleOptions): DynamicModule;
+    static registerAsync(options: TasksPublisherModuleAsyncOptions): 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 TasksPublisherModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TasksPublisherModule = 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 TasksPublisherModule = TasksPublisherModule_1 = class TasksPublisherModule {
+    static register(options = {}) {
+        const providers = [
+            (0, nest_cloud_run_queue_common_1.createOptionProvider)(constants_1.TASKS_PUBLISHER_MODULE_OPTIONS, options),
+            publish_service_1.TasksPublisherService,
+            { provide: constants_1.TASKS_CLIENT, useValue: (0, providers_1.createClient)(options) },
+        ];
+        return {
+            exports: providers,
+            global: true,
+            module: TasksPublisherModule_1,
+            providers,
+        };
+    }
+    static registerAsync(options) {
+        const asyncProviders = [
+            ...(0, nest_cloud_run_queue_common_1.createAsyncProviders)(constants_1.TASKS_PUBLISHER_MODULE_OPTIONS, options),
+            publish_service_1.TasksPublisherService,
+            {
+                inject: [constants_1.TASKS_PUBLISHER_MODULE_OPTIONS],
+                provide: constants_1.TASKS_CLIENT,
+                useFactory: (options) => (0, providers_1.createClient)(options),
+            },
+        ];
+        const providers = [...asyncProviders];
+        return {
+            exports: providers,
+            global: true,
+            imports: [...(options.imports || [])],
+            module: TasksPublisherModule_1,
+            providers,
+        };
+    }
+};
+TasksPublisherModule = TasksPublisherModule_1 = __decorate([
+    (0, common_1.Module)({})
+], TasksPublisherModule);
+exports.TasksPublisherModule = TasksPublisherModule;

package/dist/publish.service.d.ts

@@ -0,0 +1,8 @@
+import { CloudTasksClient } from "@google-cloud/tasks";
+import { TasksPublisherModuleOptions, PublishData, PublishOptions } from "./interfaces";
+export declare class TasksPublisherService {
+    private readonly options;
+    private readonly client;
+    constructor(options: TasksPublisherModuleOptions, client: CloudTasksClient);
+    publish<T>(message: PublishData<T>, options?: PublishOptions): Promise<string>;
+}

package/dist/publish.service.js

@@ -0,0 +1,64 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TasksPublisherService = void 0;
+const tasks_1 = require("@google-cloud/tasks");
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+let TasksPublisherService = class TasksPublisherService {
+    constructor(options, client) {
+        this.options = options;
+        this.client = client;
+    }
+    publish(message, options) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
+        return __awaiter(this, void 0, void 0, function* () {
+            const taskMessage = ((_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;
+            const [task] = yield this.client.createTask({
+                parent: (options === null || options === void 0 ? void 0 : options.queue) || this.options.queue,
+                task: Object.assign(Object.assign(Object.assign({}, this.options.publishConfig), options), { httpRequest: {
+                        body: Buffer.from(JSON.stringify({ message: { data: taskMessage } })).toString("base64"),
+                        headers: Object.assign(Object.assign({ "content-type": "application/json" }, (_c = options === null || options === void 0 ? void 0 : options.httpRequest) === null || _c === void 0 ? void 0 : _c.headers), (_e = (_d = this.options.publishConfig) === null || _d === void 0 ? void 0 : _d.httpRequest) === null || _e === void 0 ? void 0 : _e.headers),
+                        httpMethod: ((_f = options === null || options === void 0 ? void 0 : options.httpRequest) === null || _f === void 0 ? void 0 : _f.httpMethod) || ((_h = (_g = this.options.publishConfig) === null || _g === void 0 ? void 0 : _g.httpRequest) === null || _h === void 0 ? void 0 : _h.httpMethod) || "POST",
+                        oauthToken: ((_j = options === null || options === void 0 ? void 0 : options.httpRequest) === null || _j === void 0 ? void 0 : _j.oauthToken) || ((_l = (_k = this.options.publishConfig) === null || _k === void 0 ? void 0 : _k.httpRequest) === null || _l === void 0 ? void 0 : _l.oauthToken),
+                        oidcToken: ((_m = options === null || options === void 0 ? void 0 : options.httpRequest) === null || _m === void 0 ? void 0 : _m.oidcToken) || ((_p = (_o = this.options.publishConfig) === null || _o === void 0 ? void 0 : _o.httpRequest) === null || _p === void 0 ? void 0 : _p.oidcToken),
+                        url: ((_q = options === null || options === void 0 ? void 0 : options.httpRequest) === null || _q === void 0 ? void 0 : _q.url) || ((_s = (_r = this.options.publishConfig) === null || _r === void 0 ? void 0 : _r.httpRequest) === null || _s === void 0 ? void 0 : _s.url),
+                    } }),
+            });
+            const taskName = (task === null || task === void 0 ? void 0 : task.name) || "";
+            if ((_t = this.options.extraConfig) === null || _t === void 0 ? void 0 : _t.postPublish) {
+                yield ((_u = this.options.extraConfig) === null || _u === void 0 ? void 0 : _u.postPublish(taskMessage, taskName));
+            }
+            return taskName;
+        });
+    }
+};
+TasksPublisherService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(constants_1.TASKS_PUBLISHER_MODULE_OPTIONS)),
+    __param(1, (0, common_1.Inject)(constants_1.TASKS_CLIENT)),
+    __metadata("design:paramtypes", [Object, tasks_1.CloudTasksClient])
+], TasksPublisherService);
+exports.TasksPublisherService = TasksPublisherService;

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@anchan828/nest-cloud-run-queue-tasks-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/tasks": "2.5.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "8.4.4",
+    "rxjs": "7.5.5"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^8.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "470341e04eead0d62396245ff1a3fe0c7ad4143e"
+}