@sjcrh/proteinpaint-shared 2.78.0-0 → 2.79.1

package/LICENSE

@@ -0,0 +1,42 @@
+Copyright ©St. Jude Children’s Research Hospital 2023
+
+ 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+
+of the ProteinPaint web browser and associated documentation files (the "Software"), to utilize
+
+the Software for academic use without restriction, including without limitation the rights
+
+to use, copy, modify, merge, publish, distribute and sublicense
+
+copies of the Software for academic use, 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.
+
+ 
+
+Anyone interested in commercial use of the Software should contact the
+St. Jude Office of Technology Licensing at technology.licensing@stjude.org.

package/README.md

@@ -0,0 +1,39 @@
+# @sjcrh/proteinpaint-shared
+
+## Background
+
+This workspace was separate from the deprecated `server/shared` dir.
+The code here are meant to be consumed at runtime by either client or server
+code. Do NOT put utility/helper code here that are specific to only one
+workspace, those files should be saved in that workspace.
+
+IMPORTANT: 
+- code must work in browser and nodejs: do not import libs, deps, or globals that
+are specific to `nodejs` or `browser` environments, like `fs` or `DOM` elements
+
+## Develop
+
+For server dev, the `tsx` library will accept imports with or without file extension.
+Server (consumer) code MUST use the `.js` file extension even when importing 
+`#shared/*.ts` files.
+
+For client dev, the esbuild config will bundle the #shared imports correctly, even
+when `.js` extension is used to import what is actually a `.ts` file, by using
+custom plugins like dirname. 
+
+## Build
+
+This package will be bundled as part of the client dependencies. 
+
+For server builds, run `npm run build` to generate `src/*.js` from `src/*.ts` files.
+This is also automatically done as part of the `prepack` package script. 
+
+NOTE: For now, only code in `.js` files. OR, if using `.ts` files, 
+then commit the generated `.js` files, until a dev script or another approach
+can take care of the `.js` file requirement.
+
+## Test
+
+```sh
+npm test
+```

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@sjcrh/proteinpaint-shared",
-  "version": "2.78.0-0",
+  "version": "2.79.1",
   "description": "ProteinPaint code that is shared between server and client-side workspaces",
   "type": "module",
   "main": "src/index.js",
   "exports": {
     "./*": "./src/*"
   },
-  "directories": {
-    "test": "test"
-  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "esbuild src/*.ts --platform=node --outdir=src/ --format=esm",
+    "prepack": "npm run build",
+    "test": "ls src/test/*.spec* | xargs node"
   },
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "files": [
+    "src/*.js"
+  ],
+  "devDependencies": {
+    "esbuild": "^0.19.12"
+  }
 }

package/src/doc.js

@@ -1,9 +1,10 @@
-'use strict'
-Object.defineProperty(exports, '__esModule', { value: true })
-exports.doc = exports.test = void 0
-exports.test = {}
+const test = {};
 function doc(opts) {
-	if (opts.type in exports.test) throw "test['".concat(opts.type, "'] already exists")
-	exports.test[opts.type] = opts.test
+  if (opts.type in test)
+    throw `test['${opts.type}'] already exists`;
+  test[opts.type] = opts.test;
 }
-exports.doc = doc
+export {
+  doc,
+  test
+};

package/src/urljson.js

@@ -0,0 +1,32 @@
+const reserved = ["false", "true", "null", "undefined"];
+const delimiters = ['"', "{", "["];
+function encode(rawObject) {
+  const params = [];
+  for (const [key, value] of Object.entries(rawObject)) {
+    if (typeof value == "string" && !isNumeric(value) && !reserved.includes(value) && !delimiters.includes(value[0])) {
+      params.push(`${key}=${encodeURIComponent(value)}`);
+    } else if (value !== void 0) {
+      params.push(`${key}=${encodeURIComponent(JSON.stringify(value))}`);
+    }
+  }
+  return params.join("&");
+}
+function decode(query) {
+  const encoding = query.encoding;
+  for (const [key, value] of Object.entries(query)) {
+    if (encoding == "json" || value == "null" || // not new, always been
+    value == "true" || // NEED TO FIND-REPLACE CODE THAT USES value == 'true'
+    value == "false" || // NEED TO FIND-REPLACE CODE THAT USES value == 'false'
+    isNumeric(value) || // NEED TO check
+    value.startsWith('"') && value.endsWith('"') || value.startsWith("{") && value.endsWith("}") || value.startsWith("[") && value.endsWith("]"))
+      query[key] = JSON.parse(value);
+  }
+  return query;
+}
+function isNumeric(d) {
+  return !isNaN(parseFloat(d)) && isFinite(d) && d !== "";
+}
+export {
+  decode,
+  encode
+};

package/src/doc.ts

@@ -1,13 +0,0 @@
-export type TypeTester = (t: any) => boolean
-
-export type DocArg = {
-	type: string
-	test: TypeTester
-}
-
-export const test = {} as any
-
-export function doc(opts: DocArg) {
-	if (opts.type in test) throw `test['${opts.type}'] already exists`
-	test[opts.type] = opts.test
-}