@drawbridge/drawbridge-utils 0.0.2 → 0.0.4

package/README.md

@@ -1,18 +1,39 @@
 # @drawbridge/drawbridge-utils
 
-Shared helper functions used across the drawbridge-* repositories.
+Shared helpers and data used across the drawbridge-* repositories.
 
-## Exports
+## Main entry
 
+```js
+const utils = require( '@drawbridge/drawbridge-utils' );
+// or: import { capitalize } from '@drawbridge/drawbridge-utils';
+```
+
+Exports:
+
+- `bytesToGB( bytes )` / `bytesToMB( bytes )` — byte conversion.
 - `capitalize( string )` — uppercases the first character.
-- `formatCurrency({ code, digits, display, locale, value })` — Intl-based currency formatter. `display: 'standard'` (default) returns Intl's standard string; `'parts'` splits symbol/number for custom layouts.
-- `formatDateString({ date, locale, options })` — Intl-based date formatter.
+- `constants` — default record shape per Mongo collection name (action, brand, campaign, draw, member, organization, page, prize, range, referrer, template, usage, user).
+- `currencies` / `currency( code )` — list of ISO currencies (key/value/code/digits) and lookup by code.
+- `expiredPaymentMethod( card )` — checks if a card record's year/month is in the past.
+- `formatCurrency({ code, digits, display, locale, value })` — Intl-based formatter. `display: 'standard'` (default) returns Intl's standard string; `'parts'` splits symbol/number for custom layouts.
+- `formatDateString({ date, locale, time, options })` — Intl-based date formatter. `time: true` adds hour/minute.
 - `formatNumber( number, digits )` — Intl-based number formatter with fixed-digit min/max.
-- `getPlanFeature( plan, key )` — looks up a feature on a plan; returns `{ granted, message }`.
-- `regex` — `{ url, protocols }` shared URL regex constants.
-- `shareUrls({ formUri, organization, page })` — builds page share URLs from the configured form base URI.
-- `urlRoot( string )` — `'https://'` if the input string contains `'https'`, else `'http://'`.
-- `infinite`, `isInfinite( value )`, `megabyte`, `gigabyte` — size-related constants.
+- `getPlanFeature( plan, key )` — `{ granted, message }` lookup.
+- `infinite`, `isInfinite( value )`, `megabyte`, `gigabyte` — size constants.
+- `percentage( a, b, decimals )` — `(a / b) * 100`, fixed decimals.
+- `reducers.fields` — reducer for grouping fields by `additional` / `lead` type.
+- `regex.url` / `regex.protocols` / `regex.domain` — shared regex constants.
+- `shareUrls({ formUri, organization, page })` — builds share URLs from the configured form base URI. Falls back to `process.env.APP_CLIENT_FORM_URI` if `formUri` is not passed (server-only).
+- `urlRoot( string )` — `'https://'` if input contains `'https'`, else `'http://'`.
+
+## Encrypt entry (server-only)
+
+```js
+const { encrypt, decrypt } = require( '@drawbridge/drawbridge-utils/encrypt' );
+```
+
+Server-only because it uses Node `crypto` and reads `process.env.ENCRYPTION_KEY`. Exposed as a sub-export so client bundles don't pull Node built-ins.
 
 ## Build & publish
 
@@ -22,4 +43,4 @@ npm install
 npm run build
 ```
 
-`build` runs `tsup` (dual CJS + ESM output) and then `npm publish`. Bump the `version` in `package.json` first.
+`build` runs `tsup` (multi-entry, dual CJS + ESM output) and then `npm publish`. Bump `version` in `package.json` first.

package/dist/encrypt.cjs

@@ -0,0 +1,68 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// encrypt.js
+var encrypt_exports = {};
+__export(encrypt_exports, {
+  decrypt: () => decrypt,
+  encrypt: () => encrypt
+});
+module.exports = __toCommonJS(encrypt_exports);
+var import_crypto = __toESM(require("crypto"), 1);
+var ALGORITHM = "aes-256-gcm";
+var getKey = () => Buffer.from(process.env.ENCRYPTION_KEY, "hex");
+var encrypt = (value) => {
+  const iv = import_crypto.default.randomBytes(12);
+  const cipher = import_crypto.default.createCipheriv(ALGORITHM, getKey(), iv);
+  const data = Buffer.concat([
+    cipher.update(JSON.stringify(value), "utf8"),
+    cipher.final()
+  ]);
+  const tag = cipher.getAuthTag();
+  return [iv, tag, data].map((b) => b.toString("hex")).join(":");
+};
+var decrypt = (value) => {
+  if (typeof value !== "string") return value;
+  const [ivHex, tagHex, dataHex] = value.split(":");
+  const decipher = import_crypto.default.createDecipheriv(
+    ALGORITHM,
+    getKey(),
+    Buffer.from(ivHex, "hex")
+  );
+  decipher.setAuthTag(Buffer.from(tagHex, "hex"));
+  const result = Buffer.concat([
+    decipher.update(Buffer.from(dataHex, "hex")),
+    decipher.final()
+  ]);
+  return JSON.parse(result.toString("utf8"));
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  decrypt,
+  encrypt
+});

package/dist/encrypt.d.cts

@@ -0,0 +1,43 @@
+import crypto from 'crypto';
+
+const ALGORITHM = 'aes-256-gcm';
+
+const getKey = () => Buffer.from( process.env.ENCRYPTION_KEY, 'hex' );
+
+const encrypt = ( value ) => {
+
+	const iv = crypto.randomBytes( 12 );
+	const cipher = crypto.createCipheriv( ALGORITHM, getKey(), iv );
+	const data = Buffer.concat([
+		cipher.update( JSON.stringify( value ), 'utf8' ),
+		cipher.final()
+	]);
+	const tag = cipher.getAuthTag();
+
+	return [ iv, tag, data ].map( ( b ) => b.toString( 'hex' ) ).join( ':' );
+
+};
+
+const decrypt = ( value ) => {
+
+	if( typeof value !== 'string' ) return value;
+
+	const [ ivHex, tagHex, dataHex ] = value.split( ':' );
+	const decipher = crypto.createDecipheriv(
+		ALGORITHM,
+		getKey(),
+		Buffer.from( ivHex, 'hex' )
+	);
+
+	decipher.setAuthTag( Buffer.from( tagHex, 'hex' ) );
+
+	const result = Buffer.concat([
+		decipher.update( Buffer.from( dataHex, 'hex' ) ),
+		decipher.final()
+	]);
+
+	return JSON.parse( result.toString( 'utf8' ) );
+
+};
+
+export { decrypt, encrypt };

package/dist/encrypt.d.ts

@@ -0,0 +1,43 @@
+import crypto from 'crypto';
+
+const ALGORITHM = 'aes-256-gcm';
+
+const getKey = () => Buffer.from( process.env.ENCRYPTION_KEY, 'hex' );
+
+const encrypt = ( value ) => {
+
+	const iv = crypto.randomBytes( 12 );
+	const cipher = crypto.createCipheriv( ALGORITHM, getKey(), iv );
+	const data = Buffer.concat([
+		cipher.update( JSON.stringify( value ), 'utf8' ),
+		cipher.final()
+	]);
+	const tag = cipher.getAuthTag();
+
+	return [ iv, tag, data ].map( ( b ) => b.toString( 'hex' ) ).join( ':' );
+
+};
+
+const decrypt = ( value ) => {
+
+	if( typeof value !== 'string' ) return value;
+
+	const [ ivHex, tagHex, dataHex ] = value.split( ':' );
+	const decipher = crypto.createDecipheriv(
+		ALGORITHM,
+		getKey(),
+		Buffer.from( ivHex, 'hex' )
+	);
+
+	decipher.setAuthTag( Buffer.from( tagHex, 'hex' ) );
+
+	const result = Buffer.concat([
+		decipher.update( Buffer.from( dataHex, 'hex' ) ),
+		decipher.final()
+	]);
+
+	return JSON.parse( result.toString( 'utf8' ) );
+
+};
+
+export { decrypt, encrypt };

package/dist/encrypt.js

@@ -0,0 +1,33 @@
+// encrypt.js
+import crypto from "crypto";
+var ALGORITHM = "aes-256-gcm";
+var getKey = () => Buffer.from(process.env.ENCRYPTION_KEY, "hex");
+var encrypt = (value) => {
+  const iv = crypto.randomBytes(12);
+  const cipher = crypto.createCipheriv(ALGORITHM, getKey(), iv);
+  const data = Buffer.concat([
+    cipher.update(JSON.stringify(value), "utf8"),
+    cipher.final()
+  ]);
+  const tag = cipher.getAuthTag();
+  return [iv, tag, data].map((b) => b.toString("hex")).join(":");
+};
+var decrypt = (value) => {
+  if (typeof value !== "string") return value;
+  const [ivHex, tagHex, dataHex] = value.split(":");
+  const decipher = crypto.createDecipheriv(
+    ALGORITHM,
+    getKey(),
+    Buffer.from(ivHex, "hex")
+  );
+  decipher.setAuthTag(Buffer.from(tagHex, "hex"));
+  const result = Buffer.concat([
+    decipher.update(Buffer.from(dataHex, "hex")),
+    decipher.final()
+  ]);
+  return JSON.parse(result.toString("utf8"));
+};
+export {
+  decrypt,
+  encrypt
+};

package/dist/index.cjs

@@ -0,0 +1,407 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.js
+var index_exports = {};
+__export(index_exports, {
+  bytesToGB: () => bytesToGB,
+  bytesToMB: () => bytesToMB,
+  capitalize: () => capitalize,
+  constants: () => constants,
+  currencies: () => currencies,
+  currency: () => currency,
+  expiredPaymentMethod: () => expiredPaymentMethod,
+  formatCurrency: () => formatCurrency,
+  formatDateString: () => formatDateString,
+  formatNumber: () => formatNumber,
+  getPlanFeature: () => getPlanFeature,
+  gigabyte: () => gigabyte,
+  infinite: () => infinite,
+  isInfinite: () => isInfinite,
+  megabyte: () => megabyte,
+  percentage: () => percentage,
+  reducers: () => reducers,
+  regex: () => regex,
+  shareUrls: () => shareUrls,
+  urlRoot: () => urlRoot
+});
+module.exports = __toCommonJS(index_exports);
+var import_currency_codes = require("currency-codes");
+
+// lib/constants.js
+var font = {
+  family: "Roboto Flex",
+  transform: "none",
+  weight: "regular"
+};
+var constants_default = {
+  action: {
+    usage: {
+      actions: 0
+    }
+  },
+  brand: {
+    style: {
+      body: font,
+      heading: font
+    },
+    totals: {
+      campaigns: 0
+    }
+  },
+  campaign: {
+    agreements: {
+      marketing: {
+        enabled: false,
+        label: "I agree to the marketing terms and conditions",
+        link: null
+      },
+      terms: {
+        enabled: false,
+        label: "I agree to the terms and conditions",
+        link: null
+      }
+    },
+    defaults: {
+      active: "Enter",
+      confirmation: "Submission was successful",
+      inactive: "Submissions are closed",
+      email: "You were selected"
+    },
+    notifications: {
+      draw: {
+        subject: "You have been selected",
+        body: "Thanks for being part of our giveaway"
+      }
+    },
+    settings: {
+      submissionLeadPrimaryKey: "email",
+      submissionEntryMaximum: 1,
+      submissionEntryFilter: "campaign",
+      submissionEntryHighscore: false,
+      submissionEntryLimit: 1
+    },
+    status: "drafted",
+    totals: {
+      advertisements: 0,
+      affiliates: 0,
+      draws: 0,
+      exports: 0,
+      entries: 0,
+      fields: 2,
+      integrations: 1,
+      leads: 0,
+      links: 0,
+      pages: 0,
+      prizes: 0,
+      ranges: 0,
+      submissions: 0
+    },
+    type: "giveaway"
+  },
+  draw: {
+    status: "qualified",
+    totals: {
+      notifications: 0
+    }
+  },
+  member: {
+    status: "pending"
+  },
+  organization: {
+    errors: [],
+    totals: {
+      affiliates: 0,
+      brands: 0,
+      campaigns: 0,
+      leads: 0,
+      draws: 0,
+      entries: 0,
+      invitations: 0,
+      invoices: 0,
+      members: 0,
+      ranges: 0,
+      pages: 0,
+      prizes: 0,
+      storage: 0,
+      submissions: 0,
+      subscriptions: 0,
+      usage: 0
+    }
+  },
+  page: {
+    domains: [],
+    status: "drafted",
+    totals: {
+      leads: 0,
+      entries: 0,
+      submissions: 0
+    }
+  },
+  prize: {
+    inventory: 0,
+    remaining: 0,
+    shipping: false,
+    status: "drafted",
+    totals: {
+      draws: 0
+    }
+  },
+  range: {
+    totals: {
+      leads: 0,
+      entries: 0,
+      submissions: 0
+    }
+  },
+  referrer: {
+    totals: {
+      originizations: 0,
+      subscriptions: 0,
+      users: 0
+    }
+  },
+  template: {
+    page: {
+      style: {
+        body: font,
+        heading: font
+      }
+    }
+  },
+  usage: {
+    totals: {
+      actions: 0,
+      affiliates: 0,
+      brands: 0,
+      campaigns: 0,
+      connections: 0,
+      entries: 0,
+      files: 0,
+      members: 0,
+      orders: 0,
+      pages: 0,
+      revenue: 0,
+      storage: 0,
+      submissions: 0,
+      workflows: 0
+    }
+  },
+  user: {
+    access: {
+      ai: false
+    },
+    image: null,
+    totals: {
+      inbox: 0,
+      invitations: 0,
+      messages: 0,
+      methods: 0,
+      organizations: 1,
+      teams: 0
+    }
+  }
+};
+
+// index.js
+var constants = constants_default;
+var infinite = 1e300;
+var isInfinite = (value) => value === infinite;
+var megabyte = 1024 * 1024;
+var gigabyte = megabyte * 1024;
+var urlRoot = (string) => (string == null ? void 0 : string.includes("https")) ? "https://" : "http://";
+var bytesToGB = (bytes) => {
+  const divide = 1024 * 1024 * 1024;
+  return bytes ? Number(bytes) / divide : 0;
+};
+var bytesToMB = (bytes) => {
+  const divide = 1024 * 1024;
+  return bytes ? Number(bytes) / divide : 0;
+};
+var capitalize = (string) => {
+  var _a;
+  return ((_a = string == null ? void 0 : string.charAt(0)) == null ? void 0 : _a.toUpperCase()) + (string == null ? void 0 : string.slice(1));
+};
+var expiredPaymentMethod = (card) => {
+  const currentDate = /* @__PURE__ */ new Date();
+  const year = currentDate.getFullYear();
+  const month = (/* @__PURE__ */ new Date()).getMonth();
+  const expired = [
+    (card == null ? void 0 : card.year) < year,
+    (card == null ? void 0 : card.year) === year && (card == null ? void 0 : card.month) <= month
+  ].filter(Boolean);
+  return Boolean(expired == null ? void 0 : expired.length);
+};
+var formatCurrency = ({
+  code: code2 = "USD",
+  digits = 2,
+  display = "standard",
+  locale,
+  value = 0
+}) => {
+  var _a;
+  const resolvedLocale = locale || (typeof navigator !== "undefined" ? navigator == null ? void 0 : navigator.language : null) || "en-US";
+  const options = {
+    currency: code2,
+    minimumFractionDigits: digits,
+    maximumFractionDigits: digits,
+    style: "currency"
+  };
+  if (display === "parts") {
+    options.currencyDisplay = "narrowSymbol";
+    const parts = new Intl.NumberFormat(resolvedLocale, options).formatToParts(value);
+    const symbol = ((_a = parts.find((p) => p.type === "currency")) == null ? void 0 : _a.value) || "";
+    const number = parts.filter((p) => p.type !== "currency" && p.type !== "literal").map((p) => p.value).join("");
+    return symbol + number + " " + code2;
+  }
+  ;
+  return new Intl.NumberFormat(resolvedLocale, options).format(value);
+};
+var formatDateString = ({
+  date,
+  locale,
+  time = false,
+  options = {
+    day: "numeric",
+    month: "long",
+    weekday: "long",
+    year: "numeric"
+  }
+}) => {
+  const resolved = time ? { ...options, hour: "numeric", minute: "2-digit" } : options;
+  return new Date(date).toLocaleString(
+    locale,
+    resolved
+  );
+};
+var formatNumber = (number, digits = 0) => {
+  return Number(number).toLocaleString("en", {
+    minimumFractionDigits: digits,
+    maximumFractionDigits: digits
+  });
+};
+var getPlanFeature = (plan, key) => {
+  var _a, _b, _c, _d;
+  const error = (_b = ((_a = plan == null ? void 0 : plan.features) == null ? void 0 : _a.denied) || {}) == null ? void 0 : _b[key];
+  const feature = (_d = ((_c = plan == null ? void 0 : plan.features) == null ? void 0 : _c.granted) || {}) == null ? void 0 : _d[key];
+  const granted = Boolean(feature);
+  return {
+    granted,
+    message: granted ? feature : error
+  };
+};
+var percentage = (value1, value2, decimals = 1) => ((value1 || 0) / (value2 || 0) * 100 || 0).toFixed(decimals);
+var reducers = {
+  fields: (data2 = [], callback = () => ({})) => data2.reduce(
+    (accumulator, field) => {
+      const type = field == null ? void 0 : field.type;
+      if (!accumulator[type]) return accumulator;
+      accumulator[type].items.push({
+        ...field,
+        ...callback(field)
+      });
+      accumulator[type].keys.push(field == null ? void 0 : field.slug);
+      return accumulator;
+    },
+    {
+      additional: {
+        items: [],
+        keys: []
+      },
+      lead: {
+        items: [],
+        keys: []
+      }
+    }
+  )
+};
+var regex = {
+  domain: /^([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$/,
+  protocols: /^(https?:\/\/)?(www\.)?/,
+  url: /^(https:\/\/)/
+};
+var shareUrls = ({
+  formUri,
+  organization,
+  page
+}) => {
+  var _a;
+  const resolvedFormUri = formUri || (typeof process !== "undefined" ? (_a = process.env) == null ? void 0 : _a.APP_CLIENT_FORM_URI : void 0);
+  const preface = urlRoot(resolvedFormUri);
+  const base = resolvedFormUri;
+  const qr = preface + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId) + "?qr=1";
+  const short = preface + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId);
+  const url = preface + (organization == null ? void 0 : organization.subdomain) + "." + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.slug);
+  const clients = [
+    base,
+    qr,
+    short,
+    url
+  ];
+  const urls = {
+    qr,
+    short,
+    url
+  };
+  if ((organization == null ? void 0 : organization.subdomain) && (page == null ? void 0 : page.shortId)) {
+    clients.push(preface + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId));
+    clients.push(preface + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId) + "?qr=1");
+    clients.push(preface + organization.subdomain + "." + (base == null ? void 0 : base.replace(preface, "")));
+    clients.push(preface + organization.subdomain + "." + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId));
+  }
+  ;
+  if ((organization == null ? void 0 : organization.shortId) && (page == null ? void 0 : page.slug) && (page == null ? void 0 : page.shortId)) {
+    clients.push(preface + organization.shortId + "." + (base == null ? void 0 : base.replace(preface, "")));
+    clients.push(preface + organization.shortId + "." + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.slug));
+    clients.push(preface + organization.shortId + "." + (base == null ? void 0 : base.replace(preface, "")) + "/" + (page == null ? void 0 : page.shortId));
+  }
+  ;
+  return {
+    clients,
+    urls
+  };
+};
+var currencies = import_currency_codes.data.map((item) => ({
+  ...item,
+  key: item.currency,
+  value: item.code
+}));
+var currency = (val) => (0, import_currency_codes.code)(val);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  bytesToGB,
+  bytesToMB,
+  capitalize,
+  constants,
+  currencies,
+  currency,
+  expiredPaymentMethod,
+  formatCurrency,
+  formatDateString,
+  formatNumber,
+  getPlanFeature,
+  gigabyte,
+  infinite,
+  isInfinite,
+  megabyte,
+  percentage,
+  reducers,
+  regex,
+  shareUrls,
+  urlRoot
+});