@opndev/html 0.0.1

package/Changes

@@ -0,0 +1,5 @@
+Revision history for @opndev/html
+
+0.0.1 Thu May 30 17:34:34 UTC 2024
+
+    * First release

package/README.md

@@ -0,0 +1,48 @@
+# Welcome to @opndev/html
+
+This is a utility function package for HTML based actions. It is an ESM package.
+
+[If you want to know more, have a look at our documenation](https://opndev.gitlab.io/javascript/opndev-js-util/)
+
+## Development
+
+Try to keep functions small and try not to depend on any outside functions. We
+aim to keep the dependency graph as small as possible. The use of `esm` is
+welcomed and writing tests is encouraged.
+
+### jsdoc
+
+You can build the documentation by running `npm run jsdoc`.
+
+### eslint
+
+The ES Linting profile is flexible and does not try to enforce much. There is
+more than one way to do it ([TIMTOWTDI](https://en.wikipedia.org/wiki/There%27s_more_than_one_way_to_do_it)).
+
+Try to stay constistent, but forcing a programming style upon others is bad.
+
+### gitignore
+
+Please educate yourself and use a global gitignore file. Somes files will
+always be there. I'm looking at you `node_modules`.
+
+### The lockfiles
+You'll also see that `package-lock.json` and/or `yarn.lock` are ignored. I
+strongly believe that pinning packages lead to bit rot, as you never update
+packages. When a downstream module breaks its API you should know and update
+your code accordingly. The same goes for possible upstream modules. If you want
+a specific version, pin it to that version, otherwise use the latest and
+greatest when possible.
+
+### Code of conduct
+
+There is none, stay human, communicate and accept that some people have
+different opinions.
+
+### Pull requests
+
+I'm happy to accept pull requests, just make sure your change has tests.
+Add a good commit message and commit with a sign-off `git commit -s`.
+
+A good commit message isn't just `issue(feat): added foo to bar` but also
+explain the why in the commit.

package/README.md.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Wesley Schwengle
+
+SPDX-License-Identifier: MIT

package/lib/index.mjs

@@ -0,0 +1,15 @@
+// SPDX-FileCopyrightText: 2024 Wesley Schwengle
+//
+// SPDX-License-Identifier: MIT
+
+/**
+ *
+ * @module module:@opndev/html
+ *
+ * @exports xhr
+ *
+ * Export all the useful functions. Unfortunatly, without webpack's
+ * require.context we cannot automaticly load everything. So we just keep
+ * typing. ES6 requires strict syntax on import and exports :/
+ */
+export { isInfo, isSuccess, isError, isServerError, isClientError } from './xhr.mjs'

package/lib/xhr.mjs

@@ -0,0 +1,44 @@
+// SPDX-FileCopyrightText: 2024 Wesley Schwengle
+//
+// SPDX-License-Identifier: MIT
+
+export {
+  isSuccess,
+  isError,
+  isClientError,
+  isServerError,
+  isRedirect,
+  isInfo
+}
+
+function isInStatusRange(xhr, code) {
+  if (xhr.status >= code && xhr.status < code+100)
+    return true;
+  return false
+}
+
+function isInfo(xhr) {
+  return isInStatusRange(xhr, 100);
+}
+
+function isSuccess(xhr) {
+  return isInStatusRange(xhr, 200);
+}
+
+function isRedirect(xhr) {
+  return isInStatusRange(xhr, 300);
+}
+
+function isClientError(xhr) {
+  return isInStatusRange(xhr, 400);
+}
+
+function isServerError(xhr) {
+  return isInStatusRange(xhr, 500);
+}
+
+function isError(xhr) {
+  if (isClientError(xhr) || isServerError(xhr))
+    return true;
+  return false
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@opndev/html",
+  "version": "0.0.1",
+  "description": "HTML utility functions for OPN Development",
+  "main": "lib/index.mjs",
+  "type": "module",
+  "mode": "auto",
+  "sideEffects": false,
+  "homepage": "https://opndev.gitlab.io/javascript/opndev-js-html/",
+  "repository": {
+    "url": "git+https://gitlab.com/opndev/javascript/opndev-js-html.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/opndev/javascript/opndev-js-html/issues"
+  },
+  "scripts": {
+    "test": "tap",
+    "jsdoc" : "jsdoc -c jsdoc.json"
+  },
+  "author": {
+    "name": "Wesley Schwengle",
+    "email": "wesley@opndev.io",
+    "url": "https://opndev.io"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "jsdoc" : "latest",
+    "tap": "latest"
+  },
+  "files": [
+    "lib/*.mjs",
+    "README.md",
+    "Changes"
+  ]
+}