@ibgib/core-gib 0.0.4

package/src/common/form/form-items.mts

@@ -0,0 +1,236 @@
+/**
+ * @module
+ *
+ * Types used in bindings for forms/dynamic forms.
+ *
+ * ## transitioning development
+ *
+ * I am transitioning from a ad hoc field behavior with angular templated forms
+ * to a slightly more powerful dynamic form fields that leverages angular's
+ * reactive forms. So many of the later properties of {@link FormItemInfo} are
+ * optional for backwards compatibility. These may become required in the
+ * future, once I have dynamic forms more fleshed out.
+ */
+
+/**
+ * For when you want options with both a label and icons.
+ */
+export interface SelectOptionWithIcon {
+  label: string;
+  icon: string;
+  value: string;
+}
+
+/**
+ * Used in modal forms.
+ */
+export interface FormItemInfo {
+  /**
+   * Property name
+   */
+  name: string;
+  /**
+   *
+   */
+  value?: string | number | boolean;
+  /**
+   * If set, the value will default to this.
+   */
+  defaultValue?: string | number | boolean;
+  /**
+   * Label for the property on a form
+   */
+  label?: string;
+  /**
+   * Optional description for the property. Can bind title/hover/tooltip to this.
+   */
+  description?: string;
+  /**
+   * Placeholder when entering the field's data.
+   */
+  placeholder?: string;
+  /**
+   * Validation regular expression
+   *
+   * If you change this on a field, you should always change
+   * the {@link regexpErrorMsg} !
+
+   * @see {@link regexpErrorMsg}
+   */
+  regexp?: RegExp;
+  /**
+   * If provided, this tries to give guidance on regexp failures.
+   *
+   * NOTE this can always get out of sync with the regexp!
+   * @see {@link regexp}
+   */
+  regexpErrorMsg?: string;
+  /**
+   * regexp.source
+   */
+  // regexpSource?: string;
+  /**
+   * Only required if wanting to do validation beyond regexp/required.
+   */
+  fnValid?: (value: string | number) => boolean;
+  /**
+   * Default error message, often used with {@see fnValid}.
+   *
+   * @see {@link regexpErrorMsg}
+   *
+   * ## in the future, this may be changed to a
+   * `string | {[error: string]: string}` which would be a better
+   * solution probably.
+   */
+  defaultErrorMsg?: string;
+  /**
+   * If the field is required.
+   */
+  required?: boolean;
+  /**
+   * If true, will not log field and will use type='password', unless the field
+   * is {@link unmasked}.
+   */
+  private?: boolean;
+  /**
+   * If true, will reveal a private field.
+   */
+  unmasked?: boolean;
+  /**
+   * If true, then regardless of modal state (adding/editing/viewing), this
+   * field will always be readonly.
+   */
+  readonly?: boolean;
+  /**
+   * If truthy and non-zero, then this is a composite item which contains
+   * other items.
+   *
+   * Basically with angular, this translates to either a `FormGroup` or
+   * `FormArray`.
+   */
+  items?: FormItemInfo[];
+  /**
+   * @see {@link FormItemDataType}
+   *
+   * Only should be set if {@link items} is falsy.
+   */
+  dataType?: FormItemDataType;
+  /**
+   * Options to populate a select drop-down list (valid value list). I believe
+   * this can also be populated after the field info has been created but
+   * before/while the select list is shown to the user.
+   */
+  selectOptions?: string[];
+  /**
+   * If you want your select options to include icons, use this.
+   * @see {@link selectOptions}
+   */
+  selectOptionsWithIcons?: SelectOptionWithIcon[];
+  /**
+   * If set, this will trigger when the item is selected.
+   */
+  onSelect?: (event: any, info: FormItemInfo) => Promise<void>;
+  /**
+   * If given, should be the min of the field for validation.
+   *
+   * If the dataType is some kind of text, then this refers to the length of string.
+   * If the dataType is some kind of number, then this refers to the value of the number.
+   *
+   * ## notes
+   * * there can be the regex also that looks at this value
+   *
+   * @optional
+   */
+  min?: number;
+  /**
+   * If given, should be the max of the field for validation.
+   *
+   * If the dataType is some kind of text, then this refers to the length of string.
+   * If the dataType is some kind of number, then this refers to the value of the number.
+   *
+   * ## notes
+   * * there can be the regex also that looks at this value
+   *
+   * @optional
+   */
+  max?: number;
+  /**
+   * If true, select can select multiple items.
+   *
+   * If not a select, then not sure what's up.
+   */
+  multiple?: boolean;
+  /**
+   * If control is set, then this should be a randomly generated uuid
+   * that can be uniquely associated to the control.
+   */
+  uuid?: string;
+  /**
+   * If true, then the control is errored and contains error information.
+   */
+  errored?: boolean;
+}
+
+// /** @see {@link FormItemDataType} */
+export type FormItemDataType =
+  'text' | 'textarea' | 'select' | 'toggle' | 'number' | 'form';
+/**
+ * Type of the data, to drive what kind of control will be used for data.
+ *
+ * See individual members for more info.
+ *
+ * For fields that have auto-generated UI.
+ *
+ * ATOW Pretty much mirroring html5 input types.
+ *
+ * @see {@link FormItemDataType.text}
+ * @see {@link textarea}
+ * @see {@link select}
+ * @see {@link toggle}
+ * @see {@link number}
+ */
+export const FormItemDataType = {
+  /**
+   * @example name
+   */
+  text: 'text' as FormItemDataType,
+  /**
+   * @example description
+   */
+  textarea: 'textarea' as FormItemDataType,
+  /**
+   * select string(s) from a list.
+   *
+   * @example States e.g. TX, TN, NY, etc.
+   *
+   * @see {@link FormItemInfo.multiple}
+   */
+  select: 'select' as FormItemDataType,
+  /**
+   * Boolean true/false or on/off, etc.
+   */
+  toggle: 'toggle' as FormItemDataType,
+  /**
+   * Number value
+   */
+  number: 'number' as FormItemDataType,
+  /**
+   * The item is a collection of other items.
+   */
+  form: 'form' as FormItemDataType,
+}
+
+/**
+ * syntactic sugar for `Object.values(FormItemDataType)`
+ */
+export const FORM_ITEM_DATA_TYPES = Object.values(FormItemDataType);
+
+/**
+ * A form is basically an array of form items.
+ */
+export interface DynamicForm extends FormItemInfo {
+  /**
+   * redeclared here to require children items.
+   */
+  items: FormItemInfo[];
+}

package/src/common/import-export/import-export-types.mts

@@ -0,0 +1,18 @@
+import { IbGibAddr, IbGibRel8ns } from '@ibgib/ts-gib/dist/types.mjs';
+import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+
+export interface RawExportData_V1 {
+    dependencyGraphAsString: string,
+    contextIbGibAddr: IbGibAddr;
+    tjpAddr?: IbGibAddr;
+}
+
+export interface RawExportRel8ns_V1 extends IbGibRel8ns { }
+
+/**
+ * Ibgib that contains an entire export of a given ibgib.
+ *
+ * This could potentially be huge, so I'm naming it "Raw" in hopes
+ * that in the future some type of sharding & compression might happen.
+ */
+export interface RawExportIbGib_V1 extends IbGib_V1<RawExportData_V1, RawExportRel8ns_V1> { }

package/src/common/link/link-constants.mts

@@ -0,0 +1 @@
+export const DEFAULT_LINK_TEXT_IB_SUBSTRING_LENGTH = 20;

package/src/common/link/link-helper.mts

@@ -0,0 +1,155 @@
+import * as h from '@ibgib/helper-gib';
+import { Factory_V1 as factory, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { TransformResult } from '@ibgib/ts-gib';
+
+import { IbGibSpaceAny } from '../../witness/space/space-base-v1.mjs';
+// import { persistTransformResult, } from './space.mjs';
+import { persistTransformResult } from '../../witness/space/space-helper.mjs';
+import { DEFAULT_LINK_TEXT_IB_SUBSTRING_LENGTH } from './link-constants.mjs';
+import { ONLY_HAS_NON_ALPHANUMERICS } from '@ibgib/helper-gib';
+import { GLOBAL_LOG_A_LOT } from '../../core-constants.mjs';
+import { LinkData_V1, LinkIbGib_V1 } from './link-types.mjs';
+
+const logalot = GLOBAL_LOG_A_LOT || false;
+
+
+/**
+ * generates an ib based on the link text.
+ *
+ * Basically this gets a short substring of the link text and replaces
+ * any non alphanumeric characters.
+ *
+ * @param linkText link text
+ * @returns link ib for the given link text
+ */
+export function getLinkIb(linkText: string): string {
+  const lc = `[${getLinkIb.name}]`;
+  try {
+    if (!linkText) { throw new Error(`linkText required. (E: e131bda0f94e4af1807cda8710e6fb1f)`); }
+    let saferText = linkText.replace(/\W/g, '');
+    let ibLinkText: string;
+    if (saferText.length > DEFAULT_LINK_TEXT_IB_SUBSTRING_LENGTH) {
+      ibLinkText =
+        saferText.substring(0, DEFAULT_LINK_TEXT_IB_SUBSTRING_LENGTH);
+    } else if (saferText.length > 0) {
+      ibLinkText = saferText;
+    } else {
+      // link text only has characters/nonalphanumerics.
+      ibLinkText = ONLY_HAS_NON_ALPHANUMERICS;
+    }
+
+    return `link ${ibLinkText}`;
+  } catch (error) {
+    console.error(`${lc} ${error.message}`);
+    throw error;
+  }
+}
+
+/**
+ * creates a link ibgib, returning the transform result,
+ * optionally saving it in a given {@link space}.
+ */
+export async function createLinkIbGib({
+  text,
+  saveInSpace,
+  space,
+}: {
+  /**
+   * link text
+   */
+  text: string,
+  /**
+   * If true, will save the ibgibs created in the given {@link space}.
+   */
+  saveInSpace?: boolean,
+  /**
+   * If {@link saveInSpace}, all ibgibs created in this function will be stored in
+   * this space.
+   */
+  space?: IbGibSpaceAny,
+}): Promise<TransformResult<LinkIbGib_V1>> {
+  const lc = `[${createLinkIbGib.name}]`;
+
+  if (logalot) { console.log(`${lc} starting...`); }
+  try {
+    if (!text) { throw new Error(`text required (E: bd9a29193ec7416da588fcd10de182ee)`); }
+
+    text = text.trim();
+
+    if (!text) { throw new Error(`text cannot be only whitespace (E: 5fbc0bf22388475da885993a261b01fa)`); }
+
+    const data: LinkData_V1 = { text, textTimestamp: h.getTimestamp() };
+
+    // create an ibgib with the filename and ext
+    const opts: any = {
+      parentIbGib: factory.primitive({ ib: 'link' }),
+      ib: getLinkIb(text),
+      data,
+      dna: true,
+      tjp: { uuid: true, timestamp: true },
+      nCounter: true,
+    };
+
+    // this makes it more difficult to share/sync ibgibs...
+    // if (this.addr) { opts.rel8ns = { 'link on': [this.addr] }; }
+
+    if (logalot) { console.log(`${lc} opts: ${h.pretty(opts)}`); }
+    const resLinkIbGib = await factory.firstGen(opts) as TransformResult<LinkIbGib_V1>;
+
+    if (saveInSpace) {
+      if (!space) { throw new Error(`space required if saveInSpace is truthy (E: 19af4790b5744a72bbdd995219d8f1d4)`); }
+      await persistTransformResult({ resTransform: resLinkIbGib, space });
+    }
+
+    return resLinkIbGib;
+  } catch (error) {
+    console.error(`${lc} ${error.message}`);
+    throw error;
+  }
+}
+
+export function isLink({
+  ibGib,
+}: {
+  ibGib: IbGib_V1,
+}): boolean {
+  const lc = `[${isLink.name}]`;
+  try {
+    if (logalot) { console.log(`${lc} starting...`); }
+
+    if (!ibGib) { throw new Error(`ibGib required (E: 62e4d60452824d9097702bcc9e8466f4)`); }
+
+    const { ib, data, rel8ns } = ibGib;
+
+    // try rel8ns first
+    if (!rel8ns) {
+      if (logalot) { console.log(`${lc} rel8ns falsy, NOT a link (I: 21c6bebf90a94c11aa0fb5d44501a7d9)`); }
+      return false;
+    }
+
+    // descends from link^gib
+    const ancestors = rel8ns.ancestor || [];
+    if (ancestors && ancestors.includes('link^gib')) {
+      if (logalot) { console.log(`${lc} descends from link^gib, YES is a link (I: be91be40214248c394065f8dc7a71e3b)`); }
+      return true;
+    }
+
+    // has binary qualities and ib contains 'link'
+    if (!data) {
+      if (logalot) { console.log(`${lc} data falsy, NOT a link (I: bee06c5c10ea4c04bc5d7e2244840020)`); }
+      return false;
+    }
+    if (data.text && ib?.includes('link')) {
+      if (logalot) { console.log(`${lc} has text, and ib has 'link', YES is a link (I: 306b6e1f54e94acc91622a93770d0c1e)`); }
+      return true;
+    }
+
+    if (logalot) { console.log(`${lc} reached end, doesn't have link qualities. NOT a link. (I: 43a983d5acf64970aa4310b41fd93e0f)`); }
+    return false;
+  } catch (error) {
+    console.error(`${lc} ${error.message}`);
+    throw error;
+  } finally {
+    if (logalot) { console.log(`${lc} complete.`); }
+  }
+}

package/src/common/link/link-types.mts

@@ -0,0 +1,16 @@
+import { IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+
+/**
+ * Data for a link ibGib
+ */
+export interface LinkData_V1 {
+    text: string;
+    textTimestamp?: string;
+    timestamp?: string;
+}
+
+export interface LinkRel8ns_V1 extends IbGibRel8ns_V1 {
+}
+
+export interface LinkIbGib_V1 extends IbGib_V1<LinkData_V1, LinkRel8ns_V1> {
+}