@cumulus/db 10.1.2 → 11.0.0

package/dist/translate/rules.js

@@ -1,9 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiRuleToPostgresRule = exports.translateApiRuleToPostgresRuleRaw = void 0;
+exports.translateApiRuleToPostgresRule = exports.translateApiRuleToPostgresRuleRaw = exports.translatePostgresRuleToApiRule = void 0;
 const util_1 = require("@cumulus/common/util");
 const collection_1 = require("../models/collection");
 const provider_1 = require("../models/provider");
+const translatePostgresRuleToApiRule = async (pgRule, knex, collectionPgModel = new collection_1.CollectionPgModel(), providerPgModel = new provider_1.ProviderPgModel()) => {
+    const provider = pgRule.provider_cumulus_id
+        ? await providerPgModel.get(knex, { cumulus_id: pgRule.provider_cumulus_id })
+        : undefined;
+    const collection = pgRule.collection_cumulus_id
+        ? await collectionPgModel.get(knex, { cumulus_id: pgRule.collection_cumulus_id })
+        : undefined;
+    const apiRule = {
+        name: pgRule.name,
+        workflow: pgRule.workflow,
+        provider: provider ? provider.name : undefined,
+        collection: collection ? {
+            name: collection.name,
+            version: collection.version,
+        } : undefined,
+        rule: (0, util_1.removeNilProperties)({
+            type: pgRule.type,
+            arn: pgRule.arn,
+            logEventArn: pgRule.log_event_arn,
+            value: pgRule.value,
+        }),
+        state: pgRule.enabled ? 'ENABLED' : 'DISABLED',
+        meta: pgRule.meta,
+        payload: pgRule.payload,
+        executionNamePrefix: pgRule.execution_name_prefix,
+        queueUrl: pgRule.queue_url,
+        tags: pgRule.tags ? JSON.parse(pgRule.tags) : undefined,
+        createdAt: pgRule.created_at.getTime(),
+        updatedAt: pgRule.updated_at.getTime(),
+    };
+    return (0, util_1.removeNilProperties)(apiRule);
+};
+exports.translatePostgresRuleToApiRule = translatePostgresRuleToApiRule;
 /**
  * Generate a Postgres rule record from a DynamoDB record.
  *

package/dist/types/base.d.ts

@@ -0,0 +1,5 @@
+export interface BaseRecord {
+    cumulus_id: number;
+    updated_at: Date;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/types/base.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=base.js.map

package/dist/types/collection.d.ts

@@ -1,3 +1,4 @@
+import { DuplicateHandling } from '@cumulus/types';
 export interface PostgresCollection {
     name: string;
     version: string;
@@ -5,19 +6,20 @@ export interface PostgresCollection {
     granule_id_extraction_regex: string;
     files: string;
     process?: string;
-    duplicate_handling?: string;
+    duplicate_handling?: DuplicateHandling;
     report_to_ems?: boolean;
-    sample_file_name?: string;
+    sample_file_name: string;
     url_path?: string;
     ignore_files_config_for_discovery?: boolean;
-    meta?: string;
+    meta?: object;
     tags?: string;
     created_at?: Date;
     updated_at?: Date;
 }
-export interface PostgresCollectionRecord extends PostgresCollection {
+export interface PostgresCollectionRecord extends Omit<PostgresCollection, 'tags'> {
     cumulus_id: number;
     created_at: Date;
     updated_at: Date;
+    tags: string[];
 }
 //# sourceMappingURL=collection.d.ts.map

package/dist/types/file.d.ts

@@ -8,11 +8,13 @@ export interface PostgresFile {
     file_size?: number;
     path?: string;
     source?: string;
+    type?: string;
 }
-export interface PostgresFileRecord extends PostgresFile {
+export interface PostgresFileRecord extends Omit<PostgresFile, 'file_size'> {
     bucket: string;
     key: string;
     cumulus_id: number;
+    file_size?: string;
     created_at: Date;
     updated_at: Date;
 }

package/dist/types/granule.d.ts

@@ -24,8 +24,9 @@ export interface PostgresGranule extends PostgresGranuleUniqueColumns {
     processing_end_date_time?: Date;
     query_fields?: unknown;
 }
-export interface PostgresGranuleRecord extends PostgresGranule {
+export interface PostgresGranuleRecord extends Omit<PostgresGranule, 'product_volume'> {
     cumulus_id: number;
+    product_volume?: string;
     created_at: Date;
     updated_at: Date;
 }

package/dist/types/pdr.d.ts

@@ -1,5 +1,6 @@
+import { PdrStatus } from '@cumulus/types/api/pdrs';
 export interface PostgresPdr {
-    status: string;
+    status: PdrStatus;
     name: string;
     collection_cumulus_id: number;
     provider_cumulus_id: number;

package/dist/types/provider.d.ts

@@ -27,7 +27,7 @@ export interface PostgresProvider {
  * postgres for reading.  It differs from the PostgresProvider interface in that it types
  * the autogenerated/required fields in the Postgres database as required
  */
-export interface PostgresProviderRecord extends Omit<PostgresProvider, 'allowed_redirects'> {
+export interface PostgresProviderRecord extends PostgresProvider {
     cumulus_id: number;
     created_at: Date;
     updated_at: Date;

package/dist/types/provider.js

@@ -1,3 +1,9 @@
 "use strict";
+/**
+ * PostgresProvider
+ *
+ * This interface describes a Provider object in postgres compatible format that
+ * is ready for write to Cumulus's postgres database instance
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=provider.js.map

package/dist/types/query.d.ts

@@ -0,0 +1,10 @@
+import { PostgresGranuleRecord } from './granule';
+export declare type ProviderNameColumn = {
+    providerName: string;
+};
+export declare type CollectionNameAndVersionColumns = {
+    collectionName: string;
+    collectionVersion: string;
+};
+export declare type GranuleWithProviderAndCollectionInfo = PostgresGranuleRecord & ProviderNameColumn & CollectionNameAndVersionColumns;
+//# sourceMappingURL=query.d.ts.map

package/dist/types/query.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=query.js.map

package/dist/types/record.d.ts

@@ -0,0 +1,5 @@
+export interface UpdatedAtRange {
+    updatedAtFrom?: Date;
+    updatedAtTo?: Date;
+}
+//# sourceMappingURL=record.d.ts.map

package/dist/types/record.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=record.js.map

package/dist/types/rule.d.ts

@@ -1,7 +1,8 @@
+import { RuleType, RuleMeta } from '@cumulus/types/api/rules';
 export interface PostgresRule {
     name: string;
     workflow: string;
-    type: string;
+    type: RuleType;
     enabled: boolean;
     collection_cumulus_id?: number;
     provider_cumulus_id?: number;
@@ -10,7 +11,7 @@ export interface PostgresRule {
     arn?: string;
     log_event_arn?: string;
     payload?: object;
-    meta?: object;
+    meta?: RuleMeta;
     tags?: string;
     queue_url?: string;
     created_at: Date | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "10.1.2",
+  "version": "11.0.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,12 +29,12 @@
     "node": ">=12.18.0"
   },
   "dependencies": {
-    "@cumulus/aws-client": "10.1.2",
-    "@cumulus/common": "10.1.2",
-    "@cumulus/errors": "10.1.2",
-    "@cumulus/logger": "10.1.2",
-    "@cumulus/message": "10.1.2",
-    "@cumulus/types": "10.1.2",
+    "@cumulus/aws-client": "11.0.0",
+    "@cumulus/common": "11.0.0",
+    "@cumulus/errors": "11.0.0",
+    "@cumulus/logger": "11.0.0",
+    "@cumulus/message": "11.0.0",
+    "@cumulus/types": "11.0.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "0.0.1",
     "knex": "0.95.15",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "3b59753fa85064549b70ad8ed4a4ee213c5af313"
+  "gitHead": "e922ad12fd94affa6cd60a97a184a465a756c50b"
 }

package/dist/translate/pdrs.d.ts

@@ -1,19 +0,0 @@
-import { Knex } from 'knex';
-import { CollectionPgModel } from '../models/collection';
-import { ExecutionPgModel } from '../models/execution';
-import { ProviderPgModel } from '../models/provider';
-import { PostgresPdr } from '../types/pdr';
-/**
- * Generate a Postgres PDR record from a DynamoDB record.
- *
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} dynamoRecord
- *   Record from DynamoDB
- * @param {Knex | Knex.Transaction} knexOrTransaction
- *   Knex client for reading from RDS database
- * @param {Object} collectionPgModel - Instance of the collection database model
- * @param {Object} providerPgModel   - Instance of the provider database model
- * @param {Object} executionPgModel  - Instance of the execution database model
- * @returns {PostgresPdr} A PDR PG record
- */
-export declare const translateApiPdrToPostgresPdr: (dynamoRecord: AWS.DynamoDB.DocumentClient.AttributeMap, knexOrTransaction: Knex | Knex.Transaction, collectionPgModel?: CollectionPgModel, providerPgModel?: ProviderPgModel, executionPgModel?: ExecutionPgModel) => Promise<PostgresPdr>;
-//# sourceMappingURL=pdrs.d.ts.map

package/dist/translate/pdrs.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiPdrToPostgresPdr = void 0;
-const collection_1 = require("../models/collection");
-const execution_1 = require("../models/execution");
-const provider_1 = require("../models/provider");
-const { deconstructCollectionId } = require('@cumulus/message/Collections');
-/**
- * Generate a Postgres PDR record from a DynamoDB record.
- *
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} dynamoRecord
- *   Record from DynamoDB
- * @param {Knex | Knex.Transaction} knexOrTransaction
- *   Knex client for reading from RDS database
- * @param {Object} collectionPgModel - Instance of the collection database model
- * @param {Object} providerPgModel   - Instance of the provider database model
- * @param {Object} executionPgModel  - Instance of the execution database model
- * @returns {PostgresPdr} A PDR PG record
- */
-const translateApiPdrToPostgresPdr = async (dynamoRecord, knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), providerPgModel = new provider_1.ProviderPgModel(), executionPgModel = new execution_1.ExecutionPgModel()) => {
-    const { name, version } = deconstructCollectionId(dynamoRecord.collectionId);
-    const pdrRecord = {
-        name: dynamoRecord.pdrName,
-        provider_cumulus_id: await providerPgModel.getRecordCumulusId(knexOrTransaction, { name: dynamoRecord.provider }),
-        collection_cumulus_id: await collectionPgModel.getRecordCumulusId(knexOrTransaction, { name, version }),
-        execution_cumulus_id: dynamoRecord.execution
-            ? await executionPgModel.getRecordCumulusId(knexOrTransaction, { url: dynamoRecord.execution })
-            : undefined,
-        status: dynamoRecord.status,
-        progress: dynamoRecord.progress,
-        pan_sent: dynamoRecord.PANSent,
-        pan_message: dynamoRecord.PANmessage,
-        stats: dynamoRecord.stats,
-        address: dynamoRecord.address,
-        original_url: dynamoRecord.originalUrl,
-        timestamp: dynamoRecord.timestamp ? new Date(dynamoRecord.timestamp) : undefined,
-        duration: dynamoRecord.duration,
-        created_at: new Date(dynamoRecord.createdAt),
-        updated_at: dynamoRecord.updatedAt ? new Date(dynamoRecord.updatedAt) : undefined,
-    };
-    return pdrRecord;
-};
-exports.translateApiPdrToPostgresPdr = translateApiPdrToPostgresPdr;
-//# sourceMappingURL=pdrs.js.map