@pittica/google-business-intelligence-helpers 1.0.1 → 1.2.0

package/dist/contents/storage.js

@@ -0,0 +1,43 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  getSchemaKeys
+} = require("./schema");
+const {
+  splitName
+} = require("../naming/split");
+
+/**
+ * Maps Google Cloud Storage response.
+ *
+ * @param {Array} response Google Cloud Storage response.
+ * @param {string} schemas Schema files folder path.
+ * @returns {object} Mapped response.
+ */
+exports.mapStorageResponse = (response, schemas) => {
+  const files = {};
+  getSchemaKeys(schemas).map(key => files[key] = []);
+  response.flat(3).forEach(({
+    id
+  }) => {
+    if (id) {
+      const filename = splitName(id);
+      if (typeof files[filename.name] !== "undefined") {
+        files[filename.name].push(id);
+      }
+    }
+  });
+  return Object.values(files).flat(1).map(file => splitName(file));
+};

package/dist/index.js

@@ -21,8 +21,46 @@ const {
 const {
   getSqlFilePath
 } = require("./contents/sql");
+const {
+  mapStorageResponse
+} = require("./contents/storage");
+const {
+  getTemporaryTableName,
+  getTemporaryTableSuffix
+} = require("./naming/dataset");
+const {
+  partsToDate,
+  stringToDate
+} = require("./naming/date");
+const {
+  getFilenameVersion,
+  getJsonStorageName,
+  createFilename,
+  mergeFilename
+} = require("./naming/file");
+const {
+  splitName,
+  splitIdByKeys
+} = require("./naming/split");
+const {
+  scriptUnlistened
+} = require("./scripts/unlistened");
 exports.getSchemas = getSchemas;
 exports.getSchema = getSchema;
 exports.getSchemaKeys = getSchemaKeys;
 exports.hasSchema = hasSchema;
-exports.getSqlFilePath = getSqlFilePath;
+exports.getSqlFilePath = getSqlFilePath;
+exports.mapStorageResponse = mapStorageResponse;
+exports.getTemporaryTableName = getTemporaryTableName;
+exports.getTemporaryTableSuffix = getTemporaryTableSuffix;
+exports.partsToDate = partsToDate;
+exports.stringToDate = stringToDate;
+exports.getFilenameVersion = getFilenameVersion;
+exports.getJsonStorageName = getJsonStorageName;
+exports.createFilename = createFilename;
+exports.mergeFilename = mergeFilename;
+exports.splitName = splitName;
+exports.splitIdByKeys = splitIdByKeys;
+exports.scripts = {
+  unlistened: scriptUnlistened
+};

package/dist/naming/dataset.js

@@ -0,0 +1,38 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  format
+} = require("date-and-time");
+
+/**
+ * Gets the suffix of a temporary table.
+ *
+ * @param {Date} date Date.
+ * @returns {string} The suffix of a temporary table.
+ */
+exports.getTemporaryTableSuffix = date => format(date, "YYYY-MM-DD");
+
+/**
+ * Gets the name of a temporary table.
+ *
+ * @param {object} filedata Filename data.
+ * @param {string} prefix The prefix of a temporary table.
+ * @returns {string} The name of a temporary table.
+ */
+exports.getTemporaryTableName = ({
+  date,
+  name,
+  version
+}, prefix) => prefix + name + "-" + version + "-" + this.getTemporaryTableSuffix(date);

package/dist/naming/date.js

@@ -0,0 +1,35 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * Converts the file name parts to a date object.
+ *
+ * @param {Array} parts String array from regular expression split representing a date from file name.
+ * @returns {Date} The date from the given array.
+ */
+exports.partsToDate = parts => new Date(parseInt(parts[1]), parseInt(parts[2]) - 1, parseInt(parts[3]));
+
+/**
+ * Extracts a date from the given date representation.
+ *
+ * @param {string} date Date in string format YYYY-MM-DD.
+ * @returns {Date} A date from the given date representation.
+ */
+exports.stringToDate = date => {
+  const split = date.split(/^(\d{4})\-(\d{2})\-(\d{2})$/gis);
+  if (split.length === 5) {
+    return this.partsToDate(split);
+  }
+  return null;
+};

package/dist/naming/file.js

@@ -0,0 +1,57 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  format
+} = require("date-and-time");
+
+/**
+ * Gets the version of a filename.
+ *
+ * @param {string} name Filename.
+ * @returns {number} The version of a filename.
+ */
+exports.getFilenameVersion = name => {
+  const split = name.split("_");
+  const last = split.slice(-1).pop();
+  const version = typeof last !== "undefined" ? parseInt(last) : 0;
+  return isNaN(version) ? 0 : version;
+};
+
+/**
+ * Gets the name of a JSON storage file.
+ *
+ * @param {Date} date Date object.
+ * @param {string} file File name.
+ * @returns {string} The name of a JSON storage file.
+ */
+exports.getJsonStorageName = (date, file) => `${format(date, "YYYY-MM-DD")}/${format(date, "YYYYMMDDHHmmss")}-${file}.json`;
+
+/**
+ * Generates a filename from the givend data.
+ *
+ * @param {object} filedata File date.
+ * @returns {string} A filename from the givend data.
+ */
+exports.createFilename = filedata => `${format(filedata.date, "YYYY-MM-DD")}-${filedata.fullname}.${filedata.extension}`;
+
+/**
+ * Merges the given filename parts.
+ *
+ * @param {Date} date File date.
+ * @param {string} name File or function name.
+ * @param {string} extension File extension.
+ * @returns {string} The merged given filename parts.
+ */
+exports.mergeFilename = (date, name, extension) => `${format(date, "YYYY-MM-DD")}-${name}.${extension.toLowerCase()}`;

package/dist/naming/split.js

@@ -0,0 +1,66 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  getFilenameVersion
+} = require("./file");
+const {
+  partsToDate
+} = require("./date");
+
+/**
+ * Splits the given filename.
+ *
+ * @param {string} name Filename.
+ * @returns {object} An object containing the splitted name.
+ */
+exports.splitName = name => {
+  const split = name.split(/^(\d{4})\-(\d{2})\-(\d{2})\-(([\w_-]+)(?:\_[0-9]+)|([\w_-]+))(?:\.(\w+))$/gis);
+  if (split.length >= 8) {
+    return {
+      date: partsToDate(split),
+      name: typeof split[5] !== "undefined" ? split[5] : split[6],
+      fullname: typeof split[4] !== "undefined" ? split[4] : name,
+      extension: split[7],
+      match: true,
+      version: typeof split[4] !== "undefined" ? getFilenameVersion(split[4]) : 0
+    };
+  } else {
+    return {
+      date: new Date(),
+      name,
+      fullname: name,
+      extension: /[.]/.exec(name) ? /[^.]+$/.exec(name) : undefined,
+      match: false,
+      version: getFilenameVersion(name)
+    };
+  }
+};
+
+/**
+ * Splits an ID into an object.
+ *
+ * @param {string} id ID representation.
+ * @param {array} keys An array of keys.
+ * @returns {object} Sliced object of the given ID.
+ */
+exports.splitIdByKeys = (id, keys) => {
+  const slices = {};
+  id.split("_").forEach((value, index) => {
+    if (typeof keys[index] !== "undefined") {
+      slices[keys[index]] = parseInt(value);
+    }
+  });
+  return slices;
+};

package/dist/scripts/unlistened.js

@@ -0,0 +1,47 @@
+// Copyright 2024-2025 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  getStorage,
+  getFiles,
+  deleteFile
+} = require("@pittica/google-cloud-storage-helpers");
+const {
+  hasSchema
+} = require("../contents/schema");
+const {
+  splitName
+} = require("../naming/split");
+
+/**
+ * Removes all not allowed files in given bucket.
+ *
+ * @param {string} bucket Bucket name.
+ * @param {string} folder Path of the local folder to scan for schemas.
+ * @returns {void}
+ */
+exports.scriptUnlistened = async (bucket, folder) => {
+  if (bucket) {
+    const storage = getStorage();
+    const [files] = await getFiles(storage, bucket);
+    files.forEach(file => {
+      const {
+        name
+      } = splitName(file.id);
+      if (!hasSchema(name, folder)) {
+        deleteFile(file);
+      }
+    });
+  }
+};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@pittica/google-business-intelligence-helpers",
   "private": false,
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Helpers for business intelligence for Google Cloud.",
   "main": "dist/index.js",
   "scripts": {
     "build": "rimraf ./dist && mkdirp ./dist && babel src --out-dir dist --copy-files",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "unlistened": "run-func ./dist/scripts/unlistened.js scriptUnlistened"
   },
   "repository": {
     "type": "git",
@@ -25,11 +26,13 @@
   },
   "homepage": "https://github.com/pittica/google-business-intelligence-helpers#README.md",
   "dependencies": {
+    "@pittica/google-cloud-storage-helpers": "^1.2.2",
+    "date-and-time": "^3.6.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.27.0",
     "mkdirp": "^3.0.1",
     "prettier": "^3.5.3",
-    "rimraf": "^6.0.1" 
+    "rimraf": "^6.0.1"
   }
 }