@radishland/runtime 0.1.0 → 0.1.2

package/client/boot.js

@@ -1,4 +1,5 @@
-// src/config.ts
+// src/utils.ts
+var spaces_sep_by_comma = /\s*,\s*/;
 var bindingConfig = {
   "checked": {
     element: ["input"],
@@ -12,9 +13,6 @@ var bindingConfig = {
   }
 };
 
-// src/utils.ts
-var spaces_sep_by_comma = /\s*,\s*/;
-
 // src/boot.ts
 var bindingsQueryString = Object.keys(bindingConfig).map(
   (property) => `[\\@bind\\:${property}]`

package/client/index.d.ts

@@ -66,22 +66,37 @@ declare class HandlerRegistry extends HTMLElement implements AutonomousCustomEle
 }
 
 declare const isState: (value: unknown) => value is InstanceType<typeof Signal>;
+/**
+ * Creates a new signal
+ *
+ * @param value The initial value
+ */
 declare const signal: <T>(value: T) => Signal<T>;
+/**
+ * Creates a read-only computed signal based on the values of other signals
+ *
+ * The computed value is updated when a tracked dependency changes
+ *
+ * @param computation The callback function doing the computation
+ */
 declare const computed: <T>(computation: () => T) => ReadonlySignal<T>;
 /**
- * Create an unowned effect that must be cleanup up manually
+ * Creates an unowned effect that must be cleaned up manually and runs arbitrary code in response to signals change.
+ *
+ * @param cb The effect callback to run when a tracked dependency changes. Can return a cleanup function, executed when the effect is re-run or is disposed of.
+ *
+ * @param options An AbortSignal can be passed to abort the effect
  *
- * Accept an AbortSignal to abort the effect
+ * @return a function to unsubscribe and cleanup the effect
  */
 declare const effect: (cb: EffectCallback, options?: EffectOptions) => Destructor;
 /**
  * Creates a deeply reactive proxied object or array
  *
  * @example  const obj = reactive({ a: { b: { c: 1 } } });
-
   const computation = computed(() => obj.a.b.c * 2});
-  assertEquals(computation.value, 2);
 
+  assertEquals(computation.value, 2);
   obj.a.b.c = 2;
   assertEquals(computation.value, 4);
  */

package/client/index.js

@@ -77,8 +77,6 @@ var booleanAttributes = [
   "selected"
   // on <option>
 ];
-
-// src/config.ts
 var bindingConfig = {
   "checked": {
     element: ["input"],

package/client/utils.d.ts

@@ -0,0 +1,30 @@
+declare const spaces_sep_by_comma: RegExp;
+/**
+ * Idempotent string conversion to kebab-case
+ */
+declare const toKebabCase: (str: string) => string;
+/**
+ * Idempotent string conversion to PascalCase
+ */
+declare const toPascalCase: (str: string) => string;
+type LooseAutocomplete<T extends string> = T | Omit<string, T>;
+type Types = LooseAutocomplete<"null" | "undefined" | "boolean" | "number" | "bigint" | "string" | "symbol" | "function" | "class" | "array" | "date" | "error" | "regexp" | "object">;
+/**
+ * A more reliable `typeof` function
+ */
+declare function type(value: unknown): Types;
+declare const booleanAttributes: string[];
+declare const bindingConfig: {
+    checked: {
+        element: string[];
+        type: string[];
+        event: string;
+    };
+    value: {
+        element: string[];
+        type: string[];
+        event: string;
+    };
+};
+
+export { bindingConfig, booleanAttributes, spaces_sep_by_comma, toKebabCase, toPascalCase, type };

package/client/utils.js

@@ -0,0 +1,123 @@
+// src/utils.ts
+var is_upper = /[A-Z]/;
+var spaces_sep_by_comma = /\s*,\s*/;
+var toKebabCase = (str) => {
+  let kebab = "";
+  for (let index = 0; index < str.length; index++) {
+    const char = str[index];
+    if (index !== 0 && is_upper.test(char)) {
+      kebab += `-${char.toLowerCase()}`;
+    } else {
+      kebab += char.toLowerCase();
+    }
+  }
+  return kebab;
+};
+var toPascalCase = (str) => {
+  let pascal = "";
+  let toUpper = true;
+  for (let index = 0; index < str.length; index++) {
+    const char = str[index];
+    if (char === "-") {
+      toUpper = true;
+      continue;
+    }
+    if (toUpper) {
+      pascal += char.toUpperCase();
+      toUpper = false;
+    } else {
+      pascal += char.toLowerCase();
+    }
+  }
+  return pascal;
+};
+function type(value) {
+  if (value === null) {
+    return "null";
+  }
+  if (value === void 0) {
+    return "undefined";
+  }
+  const baseType = typeof value;
+  if (!["object", "function"].includes(baseType)) {
+    return baseType;
+  }
+  if (typeof value === "object" && Symbol.toStringTag in value) {
+    const tag = value[Symbol.toStringTag];
+    if (typeof tag === "string") {
+      return tag;
+    }
+  }
+  if (baseType === "function" && Function.prototype.toString.call(value).startsWith("class")) {
+    return "class";
+  }
+  const className = value.constructor.name;
+  if (typeof className === "string" && className !== "") {
+    return className.toLowerCase();
+  }
+  return baseType;
+}
+var booleanAttributes = [
+  "allowfullscreen",
+  // on <iframe>
+  "async",
+  // on <script>
+  "autofocus",
+  // on <button>, <input>, <select>, <textarea>
+  "autoplay",
+  // on <audio>, <video>
+  "checked",
+  // on <input type="checkbox">, <input type="radio">
+  "controls",
+  // on <audio>, <video>
+  "default",
+  // on <track>
+  "defer",
+  // on <script>
+  "disabled",
+  // on form elements like <button>, <fieldset>, <input>, <optgroup>, <option>,<select>, <textarea>
+  "formnovalidate",
+  // on <button>, <input type="submit">
+  "hidden",
+  // global
+  "inert",
+  // global
+  "ismap",
+  // on <img>
+  "itemscope",
+  // global; part of microdata
+  "loop",
+  // on <audio>, <video>
+  "multiple",
+  // on <input type="file">, <select>
+  "muted",
+  // on <audio>, <video>
+  "nomodule",
+  // on <script>
+  "novalidate",
+  // on <form>
+  "open",
+  // on <details>
+  "readonly",
+  // on <input>, <textarea>
+  "required",
+  // on <input>, <select>, <textarea>
+  "reversed",
+  // on <ol>
+  "selected"
+  // on <option>
+];
+var bindingConfig = {
+  "checked": {
+    element: ["input"],
+    type: ["boolean"],
+    event: "change"
+  },
+  "value": {
+    element: ["input", "select", "textarea"],
+    type: ["string", "number"],
+    event: "input"
+  }
+};
+
+export { bindingConfig, booleanAttributes, spaces_sep_by_comma, toKebabCase, toPascalCase, type };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radishland/runtime",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "description": "The Radish runtime",
   "author": "Frédéric Crozatier",
@@ -24,6 +24,10 @@
     "./boot": {
       "import": "./client/boot.js",
       "types": "./client/boot.d.ts"
+    },
+    "./utils": {
+      "import": "./client/utils.js",
+      "types": "./client/utils.d.ts"
     }
   },
   "files": [