@arcane-utils/pubsub 1.2.3 → 1.2.4

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+import * as pubsub from '@google-cloud/pubsub';
+export { pubsub as googlePubsub };
+export { MonitoringMessage, getPubsubClient, publishAvroRecords, publishMessage, publishProductFlowMonitoringMessage, publishStorageMessage } from './pubsub.cjs';
+import '@arcane-utils/types';

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import * as pubsub from '@google-cloud/pubsub';
+export { pubsub as googlePubsub };
+export { MonitoringMessage, getPubsubClient, publishAvroRecords, publishMessage, publishProductFlowMonitoringMessage, publishStorageMessage } from './pubsub.js';
+import '@arcane-utils/types';

package/dist/pubsub.d.cts

@@ -0,0 +1,43 @@
+import { PubSub } from '@google-cloud/pubsub';
+import { MonitoringStatus } from '@arcane-utils/types';
+
+interface MonitoringMessage {
+    entity_id: number;
+    status: MonitoringStatus;
+    monitoring_id: string;
+    step: string;
+    error_message?: string;
+}
+/**
+ * Get PubSub client.
+ *
+ * To be used in Cloud Functions because of an issue with global declaration of clients.
+ */
+declare const getPubsubClient: (gcpProject: string, serviceAccount: string) => PubSub;
+/**
+ * Publish a message on PubSub.
+*/
+declare const publishMessage: (topicName: string, message: any, pubsub: PubSub, attributes?: any) => Promise<string>;
+/**
+ * Publish a message for Product Flow monitoring
+*/
+declare const publishProductFlowMonitoringMessage: (step: string, entityId: number, monitoringId: string, status: MonitoringStatus, topicName: string, pubsub: PubSub, errorMessage?: string) => Promise<string>;
+/**
+ * Publish a message similar to a storage notification
+ */
+declare const publishStorageMessage: (objectId: string, bucketId: string, topicName: string, pubsub: PubSub, monitoringId?: string) => Promise<string>;
+/**
+ *
+ * @param schemaNameOrId : schema name or id
+ * @param pubsub : pubsub client
+ * @returns : schema definition Avro
+ */
+declare const getSchema: (schemaNameOrId: string, pubsub: PubSub) => Promise<string | null | undefined>;
+/**
+ * Publish message with schema validation
+ *
+ * The schema will be retrieved from the topic metadata and validated
+ */
+declare const publishAvroRecords: (topicNameOrId: string, pubSubClient: PubSub, message: any) => Promise<string>;
+
+export { type MonitoringMessage, getPubsubClient, getSchema, publishAvroRecords, publishMessage, publishProductFlowMonitoringMessage, publishStorageMessage };

package/dist/pubsub.d.ts

@@ -0,0 +1,43 @@
+import { PubSub } from '@google-cloud/pubsub';
+import { MonitoringStatus } from '@arcane-utils/types';
+
+interface MonitoringMessage {
+    entity_id: number;
+    status: MonitoringStatus;
+    monitoring_id: string;
+    step: string;
+    error_message?: string;
+}
+/**
+ * Get PubSub client.
+ *
+ * To be used in Cloud Functions because of an issue with global declaration of clients.
+ */
+declare const getPubsubClient: (gcpProject: string, serviceAccount: string) => PubSub;
+/**
+ * Publish a message on PubSub.
+*/
+declare const publishMessage: (topicName: string, message: any, pubsub: PubSub, attributes?: any) => Promise<string>;
+/**
+ * Publish a message for Product Flow monitoring
+*/
+declare const publishProductFlowMonitoringMessage: (step: string, entityId: number, monitoringId: string, status: MonitoringStatus, topicName: string, pubsub: PubSub, errorMessage?: string) => Promise<string>;
+/**
+ * Publish a message similar to a storage notification
+ */
+declare const publishStorageMessage: (objectId: string, bucketId: string, topicName: string, pubsub: PubSub, monitoringId?: string) => Promise<string>;
+/**
+ *
+ * @param schemaNameOrId : schema name or id
+ * @param pubsub : pubsub client
+ * @returns : schema definition Avro
+ */
+declare const getSchema: (schemaNameOrId: string, pubsub: PubSub) => Promise<string | null | undefined>;
+/**
+ * Publish message with schema validation
+ *
+ * The schema will be retrieved from the topic metadata and validated
+ */
+declare const publishAvroRecords: (topicNameOrId: string, pubSubClient: PubSub, message: any) => Promise<string>;
+
+export { type MonitoringMessage, getPubsubClient, getSchema, publishAvroRecords, publishMessage, publishProductFlowMonitoringMessage, publishStorageMessage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcane-utils/pubsub",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "PubSub helper functions.",
   "type": "module",
   "main": "./dist/index.js",
@@ -29,7 +29,7 @@
   "tsup": {
     "entry": ["./src/index.ts"],
     "format": ["cjs", "esm"], 
-    "dts": false, 
+    "dts": true, 
     "splitting": false,
     "sourcemap": true,
     "clean": true,
@@ -38,7 +38,7 @@
   "keywords": [
     "arcane",
     "utils",
-    "storage"
+    "pubsub"
   ],
   "dependencies": {
     "@arcane-utils/types": "1.2.17",

package/dist/avro.d.cjs

@@ -1 +0,0 @@
-//# sourceMappingURL=avro.d.cjs.map

package/dist/avro.d.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/avro.d.js

@@ -1 +0,0 @@
-//# sourceMappingURL=avro.d.js.map

package/dist/avro.d.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}