@turndown/library 0.1.64 → 0.1.65

package/dist/types/validation/index.mjs

@@ -0,0 +1,174 @@
+// src/types/validation/index.ts
+var createValidationSchema = (fields) => {
+  const allowedFields = Object.keys(fields);
+  const requiredFields = allowedFields.filter((fieldName) => {
+    return fields[fieldName].required;
+  });
+  return {
+    fields,
+    allowedFields,
+    requiredFields,
+    validate: (value, options = {}) => {
+      if (!isRecord(value)) {
+        return {
+          success: false,
+          issues: [
+            {
+              fieldName: "body",
+              type: "INVALID_BODY"
+            }
+          ]
+        };
+      }
+      const issues = getValidationIssues(fields, value, options);
+      if (issues.length > 0) {
+        return {
+          success: false,
+          issues
+        };
+      }
+      return {
+        success: true,
+        data: value,
+        issues: []
+      };
+    }
+  };
+};
+var requiredStringField = (missingValuePolicy = "Nullish") => ({
+  required: true,
+  missingValuePolicy,
+  validate: isNonEmptyString
+});
+var optionalStringField = () => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: isNonEmptyString
+});
+var optionalNullableStringField = () => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: (value) => {
+    return value === null || isNonEmptyString(value);
+  }
+});
+var requiredEmailField = (missingValuePolicy = "BlankString") => ({
+  required: true,
+  missingValuePolicy,
+  validate: isEmail
+});
+var requiredUuidField = (missingValuePolicy = "Nullish") => ({
+  required: true,
+  missingValuePolicy,
+  validate: isUuid
+});
+var optionalNullableNonNegativeIntegerField = () => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: (value) => {
+    return value === null || Number.isInteger(value) && Number(value) >= 0;
+  }
+});
+var optionalRecordField = () => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: isRecord
+});
+var requiredEnumField = (allowedValues, missingValuePolicy = "Nullish") => ({
+  required: true,
+  missingValuePolicy,
+  validate: (value) => {
+    return isAllowedStringValue(value, allowedValues);
+  }
+});
+var optionalEnumField = (allowedValues) => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: (value) => {
+    return isAllowedStringValue(value, allowedValues);
+  }
+});
+var optionalNullableEnumField = (allowedValues) => ({
+  required: false,
+  missingValuePolicy: "Nullish",
+  validate: (value) => {
+    return value === null || isAllowedStringValue(value, allowedValues);
+  }
+});
+var getValidationIssues = (fields, value, options) => {
+  const allowedFieldSet = new Set(Object.keys(fields));
+  const issues = [];
+  Object.entries(fields).forEach(([fieldName, field]) => {
+    const fieldValue = value[fieldName];
+    if (field.required && isMissingValue(fieldValue, field.missingValuePolicy)) {
+      issues.push({
+        fieldName,
+        type: "MISSING_FIELD"
+      });
+      return;
+    }
+    if (fieldValue === void 0) {
+      return;
+    }
+    if (!field.validate(fieldValue)) {
+      issues.push({
+        fieldName,
+        type: "INVALID_FIELD"
+      });
+    }
+  });
+  if (options.rejectUnknownFields === true) {
+    Object.keys(value).forEach((fieldName) => {
+      if (!allowedFieldSet.has(fieldName)) {
+        issues.push({
+          fieldName,
+          type: "UNSUPPORTED_FIELD"
+        });
+      }
+    });
+  }
+  return issues;
+};
+var isRecord = (value) => {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+};
+var isMissingValue = (value, missingValuePolicy) => {
+  if (value === void 0 || value === null) {
+    return true;
+  }
+  return missingValuePolicy === "BlankString" && typeof value === "string" && value.trim().length === 0;
+};
+var isNonEmptyString = (value) => {
+  return typeof value === "string" && value.trim().length > 0;
+};
+var isAllowedStringValue = (value, allowedValues) => {
+  return typeof value === "string" && allowedValues.includes(value);
+};
+var isEmail = (value) => {
+  if (!isNonEmptyString(value)) {
+    return false;
+  }
+  return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value.trim());
+};
+var isUuid = (value) => {
+  if (!isNonEmptyString(value)) {
+    return false;
+  }
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(
+    value
+  );
+};
+export {
+  createValidationSchema,
+  optionalEnumField,
+  optionalNullableEnumField,
+  optionalNullableNonNegativeIntegerField,
+  optionalNullableStringField,
+  optionalRecordField,
+  optionalStringField,
+  requiredEmailField,
+  requiredEnumField,
+  requiredStringField,
+  requiredUuidField
+};
+//# sourceMappingURL=index.mjs.map

package/dist/types/validation/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/types/validation/index.ts"],"sourcesContent":["export type TValidationIssueType =\n  | \"INVALID_BODY\"\n  | \"MISSING_FIELD\"\n  | \"INVALID_FIELD\"\n  | \"UNSUPPORTED_FIELD\";\n\nexport interface IValidationIssue<TFieldName extends string = string> {\n  fieldName: TFieldName;\n  type: TValidationIssueType;\n}\n\nexport interface IValidationResult<TValue extends object> {\n  success: boolean;\n  data?: TValue;\n  issues: IValidationIssue[];\n}\n\nexport type TMissingValuePolicy = \"Nullish\" | \"BlankString\";\n\nexport interface IValidationField<TValue, TRequired extends boolean> {\n  readonly valueType?: TValue;\n  required: TRequired;\n  missingValuePolicy: TMissingValuePolicy;\n  validate: (value: unknown) => boolean;\n}\n\nexport type TValidationFieldMap = Record<\n  string,\n  IValidationField<unknown, boolean>\n>;\n\ntype TRequiredSchemaKeys<TFields extends TValidationFieldMap> = {\n  [TKey in keyof TFields]: TFields[TKey] extends IValidationField<unknown, true>\n    ? TKey\n    : never;\n}[keyof TFields];\n\ntype TOptionalSchemaKeys<TFields extends TValidationFieldMap> = Exclude<\n  keyof TFields,\n  TRequiredSchemaKeys<TFields>\n>;\n\ntype TFieldValue<TField> =\n  TField extends IValidationField<infer TValue, boolean> ? TValue : never;\n\nexport type TInferValidationFields<TFields extends TValidationFieldMap> = {\n  [TKey in TRequiredSchemaKeys<TFields>]: TFieldValue<TFields[TKey]>;\n} & {\n  [TKey in TOptionalSchemaKeys<TFields>]?: TFieldValue<TFields[TKey]>;\n};\n\nexport type TInferValidationSchemaInput<TSchema> =\n  TSchema extends IRuntimeValidationSchema<infer TFields>\n    ? TInferValidationFields<TFields>\n    : never;\n\nexport interface IRuntimeValidationSchema<\n  TFields extends TValidationFieldMap = TValidationFieldMap,\n> {\n  fields: TFields;\n  allowedFields: readonly Extract<keyof TFields, string>[];\n  requiredFields: readonly Extract<TRequiredSchemaKeys<TFields>, string>[];\n  validate: (\n    value: unknown,\n    options?: IRuntimeValidationOptions,\n  ) => IValidationResult<TInferValidationFields<TFields>>;\n}\n\nexport interface IRuntimeValidationOptions {\n  rejectUnknownFields?: boolean;\n}\n\nexport const createValidationSchema = <TFields extends TValidationFieldMap>(\n  fields: TFields,\n): IRuntimeValidationSchema<TFields> => {\n  const allowedFields = Object.keys(fields) as Extract<keyof TFields, string>[];\n  const requiredFields = allowedFields.filter((fieldName) => {\n    return fields[fieldName].required;\n  }) as Extract<TRequiredSchemaKeys<TFields>, string>[];\n\n  return {\n    fields,\n    allowedFields,\n    requiredFields,\n    validate: (value, options = {}) => {\n      if (!isRecord(value)) {\n        return {\n          success: false,\n          issues: [\n            {\n              fieldName: \"body\",\n              type: \"INVALID_BODY\",\n            },\n          ],\n        };\n      }\n\n      const issues = getValidationIssues(fields, value, options);\n\n      if (issues.length > 0) {\n        return {\n          success: false,\n          issues,\n        };\n      }\n\n      return {\n        success: true,\n        data: value as TInferValidationFields<TFields>,\n        issues: [],\n      };\n    },\n  };\n};\n\nexport const requiredStringField = (\n  missingValuePolicy: TMissingValuePolicy = \"Nullish\",\n): IValidationField<string, true> => ({\n  required: true,\n  missingValuePolicy,\n  validate: isNonEmptyString,\n});\n\nexport const optionalStringField = (): IValidationField<string, false> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: isNonEmptyString,\n});\n\nexport const optionalNullableStringField = (): IValidationField<\n  string | null,\n  false\n> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: (value): value is string | null => {\n    return value === null || isNonEmptyString(value);\n  },\n});\n\nexport const requiredEmailField = (\n  missingValuePolicy: TMissingValuePolicy = \"BlankString\",\n): IValidationField<string, true> => ({\n  required: true,\n  missingValuePolicy,\n  validate: isEmail,\n});\n\nexport const requiredUuidField = (\n  missingValuePolicy: TMissingValuePolicy = \"Nullish\",\n): IValidationField<string, true> => ({\n  required: true,\n  missingValuePolicy,\n  validate: isUuid,\n});\n\nexport const optionalNullableNonNegativeIntegerField = (): IValidationField<\n  number | null,\n  false\n> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: (value): value is number | null => {\n    return value === null || (Number.isInteger(value) && Number(value) >= 0);\n  },\n});\n\nexport const optionalRecordField = (): IValidationField<\n  Record<string, unknown>,\n  false\n> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: isRecord,\n});\n\nexport const requiredEnumField = <TValue extends string>(\n  allowedValues: readonly TValue[],\n  missingValuePolicy: TMissingValuePolicy = \"Nullish\",\n): IValidationField<TValue, true> => ({\n  required: true,\n  missingValuePolicy,\n  validate: (value): value is TValue => {\n    return isAllowedStringValue(value, allowedValues);\n  },\n});\n\nexport const optionalEnumField = <TValue extends string>(\n  allowedValues: readonly TValue[],\n): IValidationField<TValue, false> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: (value): value is TValue => {\n    return isAllowedStringValue(value, allowedValues);\n  },\n});\n\nexport const optionalNullableEnumField = <TValue extends string>(\n  allowedValues: readonly TValue[],\n): IValidationField<TValue | null, false> => ({\n  required: false,\n  missingValuePolicy: \"Nullish\",\n  validate: (value): value is TValue | null => {\n    return value === null || isAllowedStringValue(value, allowedValues);\n  },\n});\n\nconst getValidationIssues = <TFields extends TValidationFieldMap>(\n  fields: TFields,\n  value: Record<string, unknown>,\n  options: IRuntimeValidationOptions,\n): IValidationIssue[] => {\n  const allowedFieldSet = new Set(Object.keys(fields));\n  const issues: IValidationIssue[] = [];\n\n  Object.entries(fields).forEach(([fieldName, field]) => {\n    const fieldValue = value[fieldName];\n\n    if (\n      field.required &&\n      isMissingValue(fieldValue, field.missingValuePolicy)\n    ) {\n      issues.push({\n        fieldName,\n        type: \"MISSING_FIELD\",\n      });\n      return;\n    }\n\n    if (fieldValue === undefined) {\n      return;\n    }\n\n    if (!field.validate(fieldValue)) {\n      issues.push({\n        fieldName,\n        type: \"INVALID_FIELD\",\n      });\n    }\n  });\n\n  if (options.rejectUnknownFields === true) {\n    Object.keys(value).forEach((fieldName) => {\n      if (!allowedFieldSet.has(fieldName)) {\n        issues.push({\n          fieldName,\n          type: \"UNSUPPORTED_FIELD\",\n        });\n      }\n    });\n  }\n\n  return issues;\n};\n\nconst isRecord = (value: unknown): value is Record<string, unknown> => {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n};\n\nconst isMissingValue = (\n  value: unknown,\n  missingValuePolicy: TMissingValuePolicy,\n): boolean => {\n  if (value === undefined || value === null) {\n    return true;\n  }\n\n  return (\n    missingValuePolicy === \"BlankString\" &&\n    typeof value === \"string\" &&\n    value.trim().length === 0\n  );\n};\n\nconst isNonEmptyString = (value: unknown): value is string => {\n  return typeof value === \"string\" && value.trim().length > 0;\n};\n\nconst isAllowedStringValue = <TValue extends string>(\n  value: unknown,\n  allowedValues: readonly TValue[],\n): value is TValue => {\n  return typeof value === \"string\" && allowedValues.includes(value as TValue);\n};\n\nconst isEmail = (value: unknown): value is string => {\n  if (!isNonEmptyString(value)) {\n    return false;\n  }\n\n  return /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/.test(value.trim());\n};\n\nconst isUuid = (value: unknown): value is string => {\n  if (!isNonEmptyString(value)) {\n    return false;\n  }\n\n  return /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(\n    value,\n  );\n};\n"],"mappings":";AAwEO,IAAM,yBAAyB,CACpC,WACsC;AACtC,QAAM,gBAAgB,OAAO,KAAK,MAAM;AACxC,QAAM,iBAAiB,cAAc,OAAO,CAAC,cAAc;AACzD,WAAO,OAAO,SAAS,EAAE;AAAA,EAC3B,CAAC;AAED,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU,CAAC,OAAO,UAAU,CAAC,MAAM;AACjC,UAAI,CAAC,SAAS,KAAK,GAAG;AACpB,eAAO;AAAA,UACL,SAAS;AAAA,UACT,QAAQ;AAAA,YACN;AAAA,cACE,WAAW;AAAA,cACX,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,YAAM,SAAS,oBAAoB,QAAQ,OAAO,OAAO;AAEzD,UAAI,OAAO,SAAS,GAAG;AACrB,eAAO;AAAA,UACL,SAAS;AAAA,UACT;AAAA,QACF;AAAA,MACF;AAEA,aAAO;AAAA,QACL,SAAS;AAAA,QACT,MAAM;AAAA,QACN,QAAQ,CAAC;AAAA,MACX;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CACjC,qBAA0C,eACN;AAAA,EACpC,UAAU;AAAA,EACV;AAAA,EACA,UAAU;AACZ;AAEO,IAAM,sBAAsB,OAAwC;AAAA,EACzE,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU;AACZ;AAEO,IAAM,8BAA8B,OAGrC;AAAA,EACJ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU,CAAC,UAAkC;AAC3C,WAAO,UAAU,QAAQ,iBAAiB,KAAK;AAAA,EACjD;AACF;AAEO,IAAM,qBAAqB,CAChC,qBAA0C,mBACN;AAAA,EACpC,UAAU;AAAA,EACV;AAAA,EACA,UAAU;AACZ;AAEO,IAAM,oBAAoB,CAC/B,qBAA0C,eACN;AAAA,EACpC,UAAU;AAAA,EACV;AAAA,EACA,UAAU;AACZ;AAEO,IAAM,0CAA0C,OAGjD;AAAA,EACJ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU,CAAC,UAAkC;AAC3C,WAAO,UAAU,QAAS,OAAO,UAAU,KAAK,KAAK,OAAO,KAAK,KAAK;AAAA,EACxE;AACF;AAEO,IAAM,sBAAsB,OAG7B;AAAA,EACJ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU;AACZ;AAEO,IAAM,oBAAoB,CAC/B,eACA,qBAA0C,eACN;AAAA,EACpC,UAAU;AAAA,EACV;AAAA,EACA,UAAU,CAAC,UAA2B;AACpC,WAAO,qBAAqB,OAAO,aAAa;AAAA,EAClD;AACF;AAEO,IAAM,oBAAoB,CAC/B,mBACqC;AAAA,EACrC,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU,CAAC,UAA2B;AACpC,WAAO,qBAAqB,OAAO,aAAa;AAAA,EAClD;AACF;AAEO,IAAM,4BAA4B,CACvC,mBAC4C;AAAA,EAC5C,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,UAAU,CAAC,UAAkC;AAC3C,WAAO,UAAU,QAAQ,qBAAqB,OAAO,aAAa;AAAA,EACpE;AACF;AAEA,IAAM,sBAAsB,CAC1B,QACA,OACA,YACuB;AACvB,QAAM,kBAAkB,IAAI,IAAI,OAAO,KAAK,MAAM,CAAC;AACnD,QAAM,SAA6B,CAAC;AAEpC,SAAO,QAAQ,MAAM,EAAE,QAAQ,CAAC,CAAC,WAAW,KAAK,MAAM;AACrD,UAAM,aAAa,MAAM,SAAS;AAElC,QACE,MAAM,YACN,eAAe,YAAY,MAAM,kBAAkB,GACnD;AACA,aAAO,KAAK;AAAA,QACV;AAAA,QACA,MAAM;AAAA,MACR,CAAC;AACD;AAAA,IACF;AAEA,QAAI,eAAe,QAAW;AAC5B;AAAA,IACF;AAEA,QAAI,CAAC,MAAM,SAAS,UAAU,GAAG;AAC/B,aAAO,KAAK;AAAA,QACV;AAAA,QACA,MAAM;AAAA,MACR,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAED,MAAI,QAAQ,wBAAwB,MAAM;AACxC,WAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,cAAc;AACxC,UAAI,CAAC,gBAAgB,IAAI,SAAS,GAAG;AACnC,eAAO,KAAK;AAAA,UACV;AAAA,UACA,MAAM;AAAA,QACR,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AACT;AAEA,IAAM,WAAW,CAAC,UAAqD;AACrE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,IAAM,iBAAiB,CACrB,OACA,uBACY;AACZ,MAAI,UAAU,UAAa,UAAU,MAAM;AACzC,WAAO;AAAA,EACT;AAEA,SACE,uBAAuB,iBACvB,OAAO,UAAU,YACjB,MAAM,KAAK,EAAE,WAAW;AAE5B;AAEA,IAAM,mBAAmB,CAAC,UAAoC;AAC5D,SAAO,OAAO,UAAU,YAAY,MAAM,KAAK,EAAE,SAAS;AAC5D;AAEA,IAAM,uBAAuB,CAC3B,OACA,kBACoB;AACpB,SAAO,OAAO,UAAU,YAAY,cAAc,SAAS,KAAe;AAC5E;AAEA,IAAM,UAAU,CAAC,UAAoC;AACnD,MAAI,CAAC,iBAAiB,KAAK,GAAG;AAC5B,WAAO;AAAA,EACT;AAEA,SAAO,6BAA6B,KAAK,MAAM,KAAK,CAAC;AACvD;AAEA,IAAM,SAAS,CAAC,UAAoC;AAClD,MAAI,CAAC,iBAAiB,KAAK,GAAG;AAC5B,WAAO;AAAA,EACT;AAEA,SAAO,6EAA6E;AAAA,IAClF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@turndown/library",
-  "version": "0.1.64",
-  "description": "Shared TypeScript library for the Turndown suite.",
+  "version": "0.1.65",
+  "description": "Shared TypeScript contracts and validation utilities for the Turndown suite.",
   "keywords": [
     "types",
     "typescript",
@@ -16,15 +16,33 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/types/index.cjs",
+  "module": "./dist/types/index.mjs",
+  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.mjs"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.mjs",
+      "require": "./dist/types/index.cjs",
+      "default": "./dist/types/index.mjs"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.mjs",
+      "require": "./dist/types/index.cjs",
+      "default": "./dist/types/index.mjs"
+    },
+    "./validation": {
+      "types": "./dist/types/validation/index.d.ts",
+      "import": "./dist/types/validation/index.mjs",
+      "require": "./dist/types/validation/index.cjs",
+      "default": "./dist/types/validation/index.mjs"
+    },
+    "./helpers": {
+      "types": "./dist/helpers/index.d.ts",
+      "import": "./dist/helpers/index.mjs",
+      "require": "./dist/helpers/index.cjs",
+      "default": "./dist/helpers/index.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -43,7 +61,9 @@
     "test:coverage": "jest --coverage",
     "version:patch": "npm version patch",
     "version:minor": "npm version minor",
-    "version:major": "npm version major"
+    "version:major": "npm version major",
+    "check": "tsc --noEmit",
+    "prepublishOnly": "npm test && npm run check && npm run build"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",