@beabee/beabee-common 0.0.2 → 0.20.0-alpha.2

package/dist/types/utils/slug.d.ts

@@ -0,0 +1,16 @@
+type CharMap = Record<string, string>;
+interface Mode {
+    charmap: CharMap;
+    lower: boolean;
+    multicharmap: CharMap;
+    remove: RegExp | null;
+    replacement: string;
+    trim: boolean;
+}
+interface Options {
+    locale: string;
+    mode: "pretty" | "rfc3986";
+    fallback: boolean;
+}
+export declare function slug(s: string, opts?: Partial<Options & Mode>): string;
+export {};

package/dist/types/utils/validations.d.ts

@@ -0,0 +1,90 @@
+import { ContributionPeriod } from "../data/index.ts";
+/**
+ * Check if the value is a valid angle.
+ * @param value The value to check
+ */
+export declare const isAngle: (value: unknown, span?: number) => value is number;
+/**
+ * Check if the value is a valid email address.
+ * @param value The value to check
+ * @param span The span of the angle
+ */
+export declare const isEmail: (value: unknown) => value is string;
+/**
+ * Check if the value is a valid longitude/latitude pair.
+ * @param value The value to check
+ */
+export declare const isLngLat: (value: unknown) => value is [number, number];
+/**
+ * Check if the value is a valid map bounds.
+ * @param value The value to check
+ */
+export declare const isMapBounds: (value: unknown) => value is [[number, number], [number, number]];
+/**
+ * Check if the value is a valid password.
+ * @param value The value to check
+ */
+export declare const isPassword: (value: unknown) => value is string;
+/**
+ * Check if the value is a valid period.
+ * @param value The value to check
+ */
+export declare const isPeriod: (value: unknown) => value is ContributionPeriod;
+/**
+ * Check if the value is a valid slug.
+ * @param value The value to check
+ * @returns
+ */
+export declare const isSlug: (value: unknown) => value is string;
+/**
+ * Check if the value is one of the given types
+ * @param types The valid types
+ * @param value The value to check
+ */
+export declare function isType(types: Array<"string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function">, value: unknown): boolean;
+/**
+ * Check if the value is a valid URL string
+ * @param value The value to check
+ */
+export declare const isURL: (value: unknown) => value is string;
+/**
+ * Check if the value is a valid number
+ * @param value The value to check
+ */
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isAmountOfMoney: (value: unknown) => value is number;
+/**
+ * Check if the value is a valid phone number with the following rules:
+ * * Only uses numbers
+ * * Optionally starts with a `+`
+ * * Maximal length is 15 characters
+ * * Minimal length is 5 characters
+ * Note: This method is very generalised to work for as many countries as possible
+ * and does not take into whitespace, brackets or other characters commonly used
+ * in telephone number notation. To remove these, use `toPhoneNumber` instead.
+ * @param value The value to check
+ */
+export declare const isPhoneNumber: (value: unknown) => value is string;
+/**
+ * Check if the the pay fee value is correct for the given amount and period
+ *
+ * @param value The value to check
+ * @param amount The amount
+ * @param period The period
+ */
+export declare const isValidPayFee: (value: unknown, amount: unknown, period: unknown) => value is boolean;
+export declare const isNumberInRange: (value: unknown, min?: number, max?: number) => boolean;
+/**
+ * Checks if a value is a string and its length is in a range
+ * @param value The value to check
+ * @param minLength The minimum length
+ * @param maxLength The maximum length
+ */
+export declare const isTextInRange: (value: unknown, minLength?: number, maxLength?: number) => boolean;
+/**
+ * Checks if a value is a string and its word length is in a range
+ * @param value The value to check
+ * @param minWordLength The minimum word length
+ * @param maxWordLength The maximum word length
+ */
+export declare const isTextInWordRange: (value: unknown, minWordLength?: number, maxWordLength?: number) => boolean;

package/dist/types/validators/callout-component-content.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentContentSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentContentValidator: ValidatorCalloutComponent<CalloutComponentContentSchema>;

package/dist/types/validators/callout-component-input-address.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputAddressSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputAddressValidator: ValidatorCalloutComponent<CalloutComponentInputAddressSchema>;

package/dist/types/validators/callout-component-input-checkbox.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputCheckboxSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputCheckboxValidator: ValidatorCalloutComponent<CalloutComponentInputCheckboxSchema>;

package/dist/types/validators/callout-component-input-currency.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputCurrencySchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputCurrencyValidator: ValidatorCalloutComponent<CalloutComponentInputCurrencySchema>;

package/dist/types/validators/callout-component-input-date-time.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputDateTimeSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputDateTimeValidator: ValidatorCalloutComponent<CalloutComponentInputDateTimeSchema>;

package/dist/types/validators/callout-component-input-email.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputEmailSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputEmailValidator: ValidatorCalloutComponent<CalloutComponentInputEmailSchema>;

package/dist/types/validators/callout-component-input-file.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputFileSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputFileValidator: ValidatorCalloutComponent<CalloutComponentInputFileSchema>;

package/dist/types/validators/callout-component-input-number.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputNumberSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputNumberValidator: ValidatorCalloutComponent<CalloutComponentInputNumberSchema>;

package/dist/types/validators/callout-component-input-phone-number.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputPhoneNumberSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputPhoneNumberValidator: ValidatorCalloutComponent<CalloutComponentInputPhoneNumberSchema>;

package/dist/types/validators/callout-component-input-select.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputSelectSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputSelectValidator: ValidatorCalloutComponent<CalloutComponentInputSelectSchema>;

package/dist/types/validators/callout-component-input-selectable.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputSelectableSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputSelectableValidator: ValidatorCalloutComponent<CalloutComponentInputSelectableSchema>;

package/dist/types/validators/callout-component-input-signature.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputSignatureSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputSignatureValidator: ValidatorCalloutComponent<CalloutComponentInputSignatureSchema>;

package/dist/types/validators/callout-component-input-text.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputTextSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputTextValidator: ValidatorCalloutComponent<CalloutComponentInputTextSchema>;

package/dist/types/validators/callout-component-input-time.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputTimeSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputTimeValidator: ValidatorCalloutComponent<CalloutComponentInputTimeSchema>;

package/dist/types/validators/callout-component-input-url.validator.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutComponentInputUrlSchema, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentInputUrlValidator: ValidatorCalloutComponent<CalloutComponentInputUrlSchema>;

package/dist/types/validators/callout-component.validator.d.ts

@@ -0,0 +1,3 @@
+import type { CalloutComponentNestableSchema, CalloutComponentSchema, CalloutResponseAnswer, CalloutResponseAnswersNestable, ValidatorCalloutComponent } from "../types/index.ts";
+export declare const calloutComponentNestableValidator: ValidatorCalloutComponent<CalloutComponentNestableSchema>;
+export declare const calloutComponentValidator: (schema: CalloutComponentSchema, answer: CalloutResponseAnswer | CalloutResponseAnswersNestable) => boolean;

package/dist/types/validators/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./callout-component-content.validator.ts";
+export * from "./callout-component-input-address.validator.ts";
+export * from "./callout-component-input-checkbox.validator.ts";
+export * from "./callout-component-input-currency.validator.ts";
+export * from "./callout-component-input-date-time.validator.ts";
+export * from "./callout-component-input-email.validator.ts";
+export * from "./callout-component-input-file.validator.ts";
+export * from "./callout-component-input-number.validator.ts";
+export * from "./callout-component-input-phone-number.validator.ts";
+export * from "./callout-component-input-select.validator.ts";
+export * from "./callout-component-input-selectable.validator.ts";
+export * from "./callout-component-input-signature.validator.ts";
+export * from "./callout-component-input-text.validator.ts";
+export * from "./callout-component-input-time.validator.ts";
+export * from "./callout-component-input-url.validator.ts";
+export * from "./callout-component.validator.ts";

package/package.json

@@ -1,16 +1,44 @@
 {
   "name": "@beabee/beabee-common",
-  "version": "0.0.2",
-  "description": "",
-  "main": "./dist/cjs/index.js",
+  "version": "0.20.0-alpha.2",
+  "description": "Shared code between Beabee projects for Node.js, Deno and the browser",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
-  "types": "./dist/cjs/index.d.ts",
+  "types": "./dist/types/index.d.ts",
   "files": [
     "dist/"
   ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rimraf ./dist/ && tsc && tsc -p tsconfig-cjs.json",
+    "clear": "deno task clear",
+    "lint": "deno task lint",
+    "format": "deno task format",
+    "test": "deno task test",
+    "test:deno": "deno task test:deno",
+    "test:node": "deno task test:node",
+    "test:types": "tsc --noEmit --emitDeclarationOnly false",
+    "test:node:esm": "node test/node/import.mjs",
+    "test:node:cjs": "node test/node/require.cjs",
+    "build": "deno task build",
+    "build:node": "deno task build:node",
+    "build:node:esm": "deno task build:node:esm",
+    "build:node:cjs": "deno task build:node:cjs",
+    "build:types": "tsc && echo 'export * from \"./index.ts\";' > dist/types/index.d.cts",
+    "generate:index": "deno task generate:index",
+    "sync": "deno task sync",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -24,8 +52,10 @@
   },
   "homepage": "https://github.com/beabee-communityrm/beabee-common#readme",
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.1",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.8.4"
+    "@tsconfig/recommended": "^1.0.3",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "date-fns": "^3.2.0"
   }
 }

package/dist/cjs/index.d.ts

@@ -1 +0,0 @@
-export declare function add(a: number, b: number): number;

package/dist/cjs/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.add = void 0;
-function add(a, b) {
-    return a + b;
-}
-exports.add = add;

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export declare function add(a: number, b: number): number;