@datapos/datapos-development 0.2.28

package/.prettierrc.json

@@ -0,0 +1,23 @@
+{
+    "$schema": "https://json.schemastore.org/prettierrc",
+    "arrowParens": "always",
+    "bracketSameLine": false,
+    "bracketSpacing": true,
+    "cursorOffset": -1,
+    "embeddedLanguageFormatting": "auto",
+    "endOfLine": "lf",
+    "htmlWhitespaceSensitivity": "css",
+    "insertPragma": false,
+    "jsxSingleQuote": false,
+    "plugins": [],
+    "printWidth": 180,
+    "proseWrap": "preserve",
+    "quoteProps": "as-needed",
+    "semi": true,
+    "singleAttributePerLine": false,
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "none",
+    "useTabs": false,
+    "vueIndentScriptAndStyle": false
+}

package/LICENSE.md

@@ -0,0 +1,7 @@
+ISC License (ISC)
+
+Copyright 2013 Jonathan Terrell
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/LICENSES.json

@@ -0,0 +1,16 @@
+{
+    "dotenv@16.4.5": {
+        "licenses": "BSD-2-Clause",
+        "repository": "https://github.com/motdotla/dotenv",
+        "licenseFile": "node_modules/dotenv/LICENSE",
+        "licenseUrl": "https://github.com/motdotla/dotenv/raw/master/LICENSE",
+        "parents": "@datapos/datapos-dev-operations"
+    },
+    "run@1.5.0": {
+        "licenses": "UNKNOWN",
+        "repository": "https://github.com/DTrejo/run.js",
+        "licenseFile": "node_modules/run/LICENSE",
+        "licenseUrl": "https://github.com/DTrejo/run.js/raw/master/LICENSE",
+        "parents": "@datapos/datapos-dev-operations"
+    }
+}

package/README.md

@@ -0,0 +1,67 @@
+# DataPos - Development Operations Library
+
+A Javascript library of functions used to manage Data Positioning repositories.
+
+## Installation
+
+```
+npm install --save-dev @datapos-development
+```
+
+## Production Dependencies
+
+The following packages are included in the production release. Please refer to 'package.json' and 'LICENSES.json' for version and license details.
+
+| Name   | References                                                                               |
+| ------ | ---------------------------------------------------------------------------------------- |
+| dotenv | [GitHub](https://github.com/motdotla/dotenv) [NPM](https://www.npmjs.com/package/dotenv) |
+
+## Helpers
+
+The 'scriptHelpers.js' file exports the following helper functions.
+
+| Name                      | Notes |
+| ------------------------- | ----- |
+| buildConfig               |       |
+| buildPublicDirectoryIndex |       |
+| bumpVersion               |       |
+| clearDirectory            |       |
+| compilePresenter          |       |
+| syncWithGitHub            |       |
+| uploadPlugin              |       |
+
+## Repository Management Commands
+
+The following list details the repository management commands implementation by this project. For more details, please refer to the scripts section of the 'package.json' file in this project.
+
+| Name               | Key Code         | Notes                                                                                                                                                                                                                                                                              |
+| ------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| audit              | alt+ctrl+shift+a | Use [npm audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) to audit the project's dependencies for known security vulnerabilities.                                                                                                                                          |
+| build              | alt+ctrl+shift+b | NOT implemented. The JavaScript is compatible with the latest ECMA version.                                                                                                                                                                                                        |
+| bumpVersion        |                  |                                                                                                                                                                                                                                                                                    |
+| check              | alt+ctrl+shift+c | Use [npx npm-check-updates](https://github.com/raineorshine/npm-check-updates) and [npm outdated](https://docs.npmjs.com/cli/v8/commands/npm-audit) to list the dependencies in the project that are outdated. They return different results.                                      |
+| document           | alt+ctrl+shift+d | Use [npm-license-crawler](https://www.npmjs.com/package/npm-license-crawler) to identify the licenses of the project's direct production dependencies.                                                                                                                             |
+| format             | alt+ctrl+shift+f | Use [prettier](https://prettier.io/) to format the code.                                                                                                                                                                                                                           |
+| lint               | alt+ctrl+shift+l | Use [eslint](https://eslint.org/) to check the code for potential errors and enforces coding styles.                                                                                                                                                                               |
+| publishToNPM       | alt+ctrl+shift+n | Use [npm publish](https://docs.npmjs.com/cli/v8/commands/npm-publish) to publish the package to the [npm](https://www.npmjs.com/) registry. This action will publish the last synchronised version. Use the command line command 'npm publish' when publishing for the first time. |
+| release            | alt+ctrl+shift+r | Synchronise the local repository with the main GitHub repository and publish the package to the [npm](https://www.npmjs.com/) registry.                                                                                                                                            |
+| syncWithGitHub     | alt+ctrl+shift+s | Synchronise the local repository with the main GitHub repository.                                                                                                                                                                                                                  |
+| test               | alt+ctrl+shift+l | NOT implemented.                                                                                                                                                                                                                                                                   |
+| updateDependencies | alt+ctrl+shift+l | NOT implemented.                                                                                                                                                                                                                                                                   |
+
+## The 'cors.json' File
+
+Set CORS Policy on Firebase Storage Bucket (No-longer publishing to Firebase Storage)
+
+See: https://firebase.google.com/docs/storage/web/download-files#cors_configuration
+See: https://stackoverflow.com/questions/37760695/firebase-storage-and-access-control-allow-origin/37765371
+
+```
+gsutil cors set cors.json gs://datapos-prod.appspot.com
+```
+
+To list:
+
+```
+gsutil cors get gs://datapos-prod.appspot.com
+```

package/cors.json

@@ -0,0 +1,23 @@
+[
+    {
+        "origin": [
+            "https://datapos.app",
+            "https://support.datapos.app/",
+            "https://workbench.datapos.app/",
+            "https://www.datapos.app/",
+            "https://datapos-prod-firebaseapp.com",
+            "https://datapos-prod-web.app",
+            "https://datapos-prod-support.firebaseapp.com",
+            "https://datapos-prod-support.web.app",
+            "https://datapos-prod-workbench.firebaseapp.com",
+            "https://datapos-prod-workbench.web.app",
+            "http://localhost:5173",
+            "http://localhost:5174",
+            "http://localhost:5175",
+            "https://springbrook.static.observableusercontent.com",
+            "https://workbench.datapositioning.app"
+        ],
+        "method": ["GET"],
+        "maxAgeSeconds": 3600
+    }
+]

package/eslint.config.js

@@ -0,0 +1,15 @@
+export default [
+    {
+        languageOptions: {
+            ecmaVersion: 'latest'
+        },
+        linterOptions: {
+            reportUnusedDisableDirectives: true
+        },
+        rules: {
+            'no-empty': 'warn',
+            'no-unused-vars': 'warn',
+            'prefer-const': 'warn'
+        }
+    }
+];

package/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@datapos/datapos-development",
+    "license": "ISC",
+    "private": false,
+    "type": "module",
+    "version": "0.2.28",
+    "devDependencies": {
+        "eslint": "^9.28.0",
+        "nanoid": "^5.1.5",
+        "prettier": "^3.5.3",
+        "run": "^1.5.0"
+    },
+    "scripts": {
+        "audit": "npm audit",
+        "build": "echo \"***** BUILD SCRIPT NOT IMPLEMENTED. *****\"",
+        "bumpVersion": "node -e \"import('./scriptHelpers.js').then(m => m.bumpVersion())\"",
+        "check": "npx npm-check-updates && npm outdated",
+        "document": "npx npm-license-crawler --onlyDirectDependencies --production --relativeLicensePath --json LICENSES.json",
+        "format": "prettier --write *.js",
+        "lint": "npx eslint *.js",
+        "publishToNPM": "npm publish --access public",
+        "release": "npm run syncWithGitHub && npm run publishToNPM",
+        "syncWithGitHub": "npm run bumpVersion && node -e \"import('./scriptHelpers.js').then(m => m.syncWithGitHub())\"",
+        "test": "echo \"***** TEST SCRIPT NOT IMPLEMENTED. *****\"",
+        "updateDependencies": "echo \"***** UPDATE DEPENDENCIES SCRIPT NOT IMPLEMENTED. *****\""
+    }
+}

package/scriptHelpers.js

@@ -0,0 +1,154 @@
+// Dependencies - Vendor
+const fs = require('fs').promises;
+const { nanoid } = require('nanoid');
+
+// Dependencies - Vendor (Promisify Exec)
+const util = require('util');
+const exec = util.promisify(require('child_process').exec);
+
+// Operations - Build Configuration
+async function buildConfig() {
+    const configJSON = await readJSONFile('src/config.json');
+    const packageJSON = await readJSONFile('package.json');
+    fs.writeFile('src/config.json', JSON.stringify({ ...configJSON, id: packageJSON.name, version: packageJSON.version }, undefined, 4));
+}
+
+// Operations - Build Public Directory Index
+async function buildPublicDirectoryIndex(id) {
+    async function listDirectoryEntriesRecursively(directoryPath, names) {
+        const entries = [];
+        const localDirectoryPath = directoryPath.substring(`public/${id}`.length);
+        index[localDirectoryPath] = entries;
+        for (const name of names) {
+            const itemPath = `${directoryPath}/${name}`;
+            try {
+                const stats = await fs.stat(itemPath);
+                if (stats.isDirectory()) {
+                    const nextLevelChildren = await fs.readdir(itemPath);
+                    entries.push({ childCount: nextLevelChildren.length, name: `${name}`, typeId: 'folder' });
+                    await listDirectoryEntriesRecursively(itemPath, nextLevelChildren);
+                } else {
+                    entries.push({ id: nanoid(), lastModifiedAt: stats.mtimeMs, name, size: stats.size, typeId: 'object' });
+                }
+            } catch (error) {
+                console.error(`Unable to get information for '${name}' in 'buildPublicDirectoryIndex'.`, error);
+            }
+        }
+        entries.sort((left, right) => right.typeId.localeCompare(left.typeId) || left.name.localeCompare(right.name));
+    }
+
+    const index = {};
+    const toplevelNames = await fs.readdir(`public/${id}`);
+    await listDirectoryEntriesRecursively(`public/${id}`, toplevelNames);
+    fs.writeFile(`./public/${id}Index.json`, JSON.stringify(index), (error) => {
+        if (error) return console.error(error);
+    });
+}
+
+// Operations - Bump Version
+async function bumpVersion() {
+    const packageJSON = await readJSONFile('package.json');
+    const versionSegments = packageJSON.version.split('.');
+    packageJSON.version = `${versionSegments[0]}.${versionSegments[1]}.${Number(versionSegments[2]) + 1}`;
+    fs.writeFile('package.json', JSON.stringify(packageJSON, undefined, 4));
+    console.log(`Bumped to version ${packageJSON.version}.`);
+}
+
+// Operations - Clear Directory
+async function clearDirectory(directoryPath) {
+    for (const itemName of await fs.readdir(directoryPath)) {
+        const itemPath = `${directoryPath}/${itemName}`;
+        try {
+            const stats = await fs.stat(itemPath);
+            if (stats.isDirectory()) {
+                await fs.rm(itemPath, { recursive: true, force: true });
+            } else {
+                await fs.unlink(itemPath);
+            }
+        } catch (error) {
+            console.error(`Unable to get information for '${itemPath}' in 'clearDirectory'.`, error);
+        }
+    }
+}
+
+// Operations - Send Deployment Notice
+async function sendDeploymentNotice() {
+    const configJSON = await readJSONFile('src/config.json');
+    const options = {
+        body: JSON.stringify(configJSON),
+        headers: { 'Content-Type': 'application/json' },
+        method: 'PUT'
+    };
+    const response = await fetch(`https://operations.datapos.app/states/${configJSON.id}`, options);
+    if (!response.ok) console.log(await response.text());
+}
+
+// UtilitiesOperations - Sync with Github
+async function syncWithGitHub() {
+    const packageJSON = await readJSONFile('package.json');
+    await exec('git add .');
+    await exec(`git commit -m v${packageJSON.version}`);
+    await exec('git push origin main:main');
+}
+
+// Operations - Upload Directory To R2
+async function uploadDirectoryToR2(sourceDirectory, uploadDirectory) {
+    async function listDirectoryEntriesRecursively(currentSourceDirectory, currentDestinationDirectory, names) {
+        for (const name of names) {
+            const sourceItemPath = `${currentSourceDirectory}/${name}`;
+            const destinationItemPath = `${currentDestinationDirectory}/${name}`;
+            try {
+                const stats = await fs.stat(sourceItemPath);
+                if (stats.isDirectory()) {
+                    const nextLevelChildren = await fs.readdir(sourceItemPath);
+                    await listDirectoryEntriesRecursively(sourceItemPath, destinationItemPath, nextLevelChildren);
+                } else {
+                    const command = `wrangler r2 object put "datapos-sample-data-eu/${currentDestinationDirectory}/${name}" --file="${currentSourceDirectory}/${name}" --jurisdiction=eu --remote`;
+                    const response = await exec(command);
+                    console.log('Uploading:', `${currentSourceDirectory}/${name}`);
+                    if (response.stderr) {
+                        console.log('Command___:', command);
+                        console.log('Error_____:', response.stderr);
+                    }
+                }
+            } catch (error) {
+                console.error(`Unable to get information for '${name}' in 'uploadDirectoryToR2'.`, error);
+            }
+        }
+    }
+    const toplevelNames = await fs.readdir(`${sourceDirectory}/${uploadDirectory}/`);
+    await listDirectoryEntriesRecursively(`${sourceDirectory}/${uploadDirectory}`, uploadDirectory, toplevelNames);
+}
+
+// Operations - Upload Module Configuration
+async function uploadModuleConfig() {
+    const configJSON = await readJSONFile('src/config.json');
+    const stateId = configJSON.id;
+    const options = {
+        body: JSON.stringify(configJSON),
+        headers: { 'Content-Type': 'application/json' },
+        method: 'PUT'
+    };
+    const response = await fetch(`https://operations.datapos.app/states/${stateId}`, options);
+    if (!response.ok) console.log(await response.text());
+}
+
+// Operations - Upload Module To R2
+async function uploadModuleToR2(fromPath, toPath) {
+    const packageJSON = await readJSONFile('package.json');
+    const toPathWithVersion = toPath.replace(/^(.*?\.)/, `$1v${packageJSON.version}.`);
+    exec(`wrangler r2 object put ${toPathWithVersion} --file=dist/${fromPath} --content-type application/javascript --jurisdiction=eu --remote`, { stdio: 'inherit' });
+}
+
+// Utilities - Read JSON File
+async function readJSONFile(path) {
+    try {
+        return JSON.parse(await fs.readFile(path, 'utf8'));
+    } catch (error) {
+        console.warn(`WARN: JSON file '${path}' not found or invalid.`, error);
+        return {};
+    }
+}
+
+// Exposures
+export { buildConfig, buildPublicDirectoryIndex, bumpVersion, clearDirectory, sendDeploymentNotice, syncWithGitHub, uploadDirectoryToR2, uploadModuleConfig, uploadModuleToR2 };