@environment-safe/file 0.0.1

package/.babelrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+    "plugins": [
+        ["@babel/plugin-transform-modules-commonjs"],
+        ["babel-plugin-transform-import-meta"],
+        [ "search-and-replace", {
+            "rules": [
+                {
+                  "search": /\.mjs/,
+                  "replace": ".cjs"
+                },
+                {
+                  "search": /\.\/src\//,
+                  "replace": "./dist/"
+                }
+            ]
+        }]
+    ]
+}

package/.eslintrc.cjs

@@ -0,0 +1,42 @@
+module.exports = {
+    'env': {
+        'browser': true,
+        'commonjs': true,
+        'es2021': true
+    },
+    'globals': {
+        'process': 'readonly',
+        'define': 'readonly'
+    },
+    'extends': 'eslint:recommended',
+    'overrides': [
+    ],
+    'parserOptions': {
+        'ecmaVersion': 'latest',
+        'sourceType': 'module'
+    },
+    'rules': {
+        'indent': [
+            'error',
+            4,
+            { 'SwitchCase': 1 }
+        ],
+        'linebreak-style': [
+            'error',
+            'unix'
+        ],
+        'quotes': [
+            'error',
+            'single'
+        ],
+        'semi': [
+            'error',
+            'always'
+        ],
+        'no-unused-vars': [
+            'error', { 
+                'args': 'none' 
+            }
+        ]
+    }
+};

package/.husky/pre-commit

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint
+#npm run import-test
+#npm run headless-browser-test
+npm run build-commonjs
+#npm run require-test
+npm run build-docs
+npm run build-types
+npm run add-generated-files-to-commit

package/.import-config.json

@@ -0,0 +1,5 @@
+{
+    "unpkg" : "https://unpkg.com/${name}${version}/",
+    "jsdeliver" : "https://cdn.jsdelivr.net/npm/${name}${version}/",
+    "local" : "./${name}"
+}

package/.jsdoc.json

@@ -0,0 +1,15 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "source": {
+    "include": ["."],
+    "includePattern": ".(mjs)$"
+  },
+  "plugins": [ "./node_modules/tsd-jsdoc/dist/plugin" ],
+  "opts": {
+      "template": "./node_modules/tsd-jsdoc/dist"
+  },
+  "sourceType": "module"
+}

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 null.
+
+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,95 @@
+@environment-safe/file
+======================
+This is an experimental interface to provide a common file abstraction from client to server.
+
+The design goal is to give the widest possible filesystem access, while minimizing the number of client interactions (via interaction initiation *or* popup) using a common API.
+
+Usage
+-----
+
+### listing
+
+You can list contents from an arbitrary location or from one of a few predefined locations (`desktop`, `documents`, `downloads`, `music`, `pictures`, `videos`). For example to list all the files in your `documents` directory:
+
+```javascript
+const list = await File.list('documents', {
+    files: true,
+    directories: false
+});
+```
+
+You can load a file relative to the current directory, for example `foo.bar`
+
+```javascript
+const file = new File('foo.bar');
+//or
+const file = new File('foo.bar', '.');
+```
+
+You can load a file relative to the a predefined directory, for example `baz.mpg` in `videos`:
+```javascript
+const file = new File('baz.mpg', 'videos');
+```
+
+You can load a file relative to the a fully specified directory, for example `baz.info` in `/Users/me/`:
+```javascript
+const file = new File('baz.info', '/Users/me/');
+```
+
+You can load a file relative to the a relative directory, for example `package.json` in `../node_modules/dep`:
+```javascript
+const file = new File('package.json', '../node_modules/dep');
+```
+
+You can load a file directly from a fully specified path:
+```javascript
+const file = new File('/Users/me/file.ext');
+```
+
+Other scenarios may work in isolated circumstances, but are not supported client/server.
+
+
+Roadmap
+-------
+
+- [ ] - test existing suite in windows + linux
+- [ ] - safari directory returns
+- [ ] - firefox directory returns
+- [ ] - edge directory returns
+- [ ] - apache directory returns
+- [ ] - opera directory returns
+- [ ] - streaming support
+
+Testing
+-------
+
+Run the es module tests to test the root modules
+```bash
+npm run import-test
+```
+to run the same test inside the browser:
+
+```bash
+npm run browser-test
+```
+to run the same test headless in chrome:
+```bash
+npm run headless-browser-test
+```
+
+to run the same test inside docker:
+```bash
+npm run container-test
+```
+
+Run the commonjs tests against the `/dist` commonjs source (generated with the `build-commonjs` target).
+```bash
+npm run require-test
+```
+
+Development
+-----------
+All work is done in the .mjs files and will be transpiled on commit to commonjs and tested.
+
+If the above tests pass, then attempt a commit which will generate .d.ts files alongside the `src` files and commonjs classes in `dist`
+

package/containers/development.dockerfile

@@ -0,0 +1,11 @@
+FROM node:18
+
+# Install app dependencies
+COPY package*.json ./
+RUN npm install
+
+# Bundle app source
+COPY . .
+
+# run test
+CMD [ "npm", "run", "test" ]

package/containers/production.dockerfile

@@ -0,0 +1,11 @@
+FROM node:18
+
+# Install app dependencies
+COPY package*.json ./
+RUN npm ci --only=production
+
+# Bundle app source
+COPY . .
+
+# run test
+CMD [ "npm", "run", "test" ]

package/containers/test.dockerfile

@@ -0,0 +1,11 @@
+FROM node:18
+
+# Install app dependencies
+COPY package*.json ./
+RUN npm install
+
+# Bundle app source
+COPY . .
+
+# run test
+CMD [ "npm", "run", "test" ]

package/dist/buffer.cjs

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FileBuffer = void 0;
+var _browserOrNode = require("browser-or-node");
+/* global Buffer:false */
+/*
+import { isBrowser, isJsDom } from 'browser-or-node';
+import * as mod from 'module';
+import * as path from 'path';
+let internalRequire = null;
+if(typeof require !== 'undefined') internalRequire = require;
+const ensureRequire = ()=> (!internalRequire) && (internalRequire = mod.createRequire(import.meta.url));
+//*/
+
+/**
+ * A JSON object
+ * @typedef { object } JSON
+ */
+
+// TODO: make this live in streams
+
+let InternalBuffer = null;
+if (_browserOrNode.isBrowser || _browserOrNode.isJsDom) {
+  InternalBuffer = function () {};
+  var enc = new TextEncoder();
+  var dec = new TextDecoder('utf-8');
+  InternalBuffer.from = ob => {
+    const type = Array.isArray(ob) ? 'array' : typeof ob;
+    switch (type) {
+      case 'object':
+      case 'array':
+      case 'string':
+        return enc.encode(ob).buffer;
+      case '':
+    }
+  };
+  InternalBuffer.to = (type, buffer) => {
+    switch (type) {
+      case 'object':
+      case 'array':
+      case 'string':
+        return dec.decode(buffer);
+      case '':
+    }
+  };
+  InternalBuffer.alloc = (size, fill, encoding = 'utf-8') => {
+    const result = new Uint8Array(size);
+    if (fill) {
+      for (let lcv = 0; lcv < size; lcv++) {
+        result[lcv] = fill;
+      }
+    }
+    //todo: convert encoding to byte offset
+  };
+} else {
+  InternalBuffer = function () {};
+  InternalBuffer.from = (ob = '') => {
+    return Buffer.from(ob);
+  };
+  //InternalBuffer = Buffer;
+  InternalBuffer.to = (type, buffer) => {
+    switch (type) {
+      case 'object':
+        return buffer.toJSON();
+      case 'array':
+        return buffer.toJSON();
+      case 'string':
+        return buffer.toString();
+      case '':
+    }
+  };
+}
+const FileBuffer = InternalBuffer;
+exports.FileBuffer = FileBuffer;