@offlinejs/validation 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { ValidationIssue, SchemaValidator, EntityRecord, ValidationResult, StorageAdapter, OfflinePlugin } from '@offlinejs/types';
+
+declare class OfflineValidationError extends Error {
+    readonly issues: ValidationIssue[];
+    constructor(issues: ValidationIssue[]);
+}
+type ValidatorMap = Record<string, SchemaValidator>;
+declare const createRequiredFieldsValidator: (fields: string[]) => SchemaValidator;
+declare const createTypeValidator: (fieldTypes: Record<string, "string" | "number" | "boolean" | "object">) => SchemaValidator;
+declare const composeValidators: (...validators: SchemaValidator[]) => SchemaValidator;
+declare const createValidatedStorage: (storage: StorageAdapter, validators: ValidatorMap) => StorageAdapter;
+declare const validationPlugin: (validators: ValidatorMap) => OfflinePlugin;
+declare const assertValid: (validator: SchemaValidator | undefined, record: EntityRecord, collection: string) => Promise<ValidationResult>;
+
+export { OfflineValidationError, type ValidatorMap, assertValid, composeValidators, createRequiredFieldsValidator, createTypeValidator, createValidatedStorage, validationPlugin };

package/dist/index.js

@@ -0,0 +1,103 @@
+import { STORAGE_ADAPTER_CONTRACT_VERSION } from '@offlinejs/types';
+import { withIndexForwarding } from '@offlinejs/utils';
+
+// src/index.ts
+var OfflineValidationError = class extends Error {
+  issues;
+  constructor(issues) {
+    super(issues.map((issue) => issue.message).join("; ") || "Validation failed");
+    this.name = "OfflineValidationError";
+    this.issues = issues;
+  }
+};
+var createRequiredFieldsValidator = (fields) => (record) => {
+  const issues = fields.filter((field) => record[field] === void 0 || record[field] === null).map((field) => ({
+    code: "required",
+    message: `"${field}" is required`,
+    path: [field]
+  }));
+  return { issues, valid: issues.length === 0 };
+};
+var createTypeValidator = (fieldTypes) => (record) => {
+  const issues = [];
+  for (const [field, expectedType] of Object.entries(fieldTypes)) {
+    const value = record[field];
+    if (value === void 0 || value === null) {
+      continue;
+    }
+    const actualType = Array.isArray(value) ? "object" : typeof value;
+    if (actualType !== expectedType) {
+      issues.push({
+        code: "type",
+        message: `"${field}" must be of type ${expectedType}`,
+        path: [field]
+      });
+    }
+  }
+  return { issues, valid: issues.length === 0 };
+};
+var composeValidators = (...validators) => async (record, collection) => {
+  const issues = [];
+  for (const validator of validators) {
+    const result = await validator(record, collection);
+    issues.push(...result.issues);
+  }
+  return { issues, valid: issues.length === 0 };
+};
+var createValidatedStorage = (storage, validators) => {
+  const createValidatedStore = (store) => ({
+    clear: (collection) => store.clear(collection),
+    delete: (collection, id) => store.delete(collection, id),
+    find: (collection, query) => store.find(collection, query),
+    get: (collection, id) => store.get(collection, id),
+    async set(collection, value) {
+      await assertValid(validators[collection], value, collection);
+      await store.set(collection, value);
+    }
+  });
+  const wrapper = {
+    name: `${storage.name}:validated`,
+    contractVersion: STORAGE_ADAPTER_CONTRACT_VERSION,
+    ...storage.capabilities ? { capabilities: storage.capabilities } : {},
+    clear: (collection) => storage.clear(collection),
+    delete: (collection, id) => storage.delete(collection, id),
+    find: (collection, query) => storage.find(collection, query),
+    get: (collection, id) => storage.get(collection, id),
+    async set(collection, value) {
+      await assertValid(validators[collection], value, collection);
+      await storage.set(collection, value);
+    },
+    transaction: (scope, run) => storage.transaction(scope, (store) => run(createValidatedStore(store))),
+    ...storage.migrate ? { migrate: storage.migrate.bind(storage) } : {}
+  };
+  return withIndexForwarding(wrapper, storage);
+};
+var validationPlugin = (validators) => ({
+  name: "validation",
+  setup({ events }) {
+    return events.on("queue:add", async (mutation) => {
+      const validator = validators[mutation.collection];
+      if (!validator || !mutation.payload) {
+        return;
+      }
+      const result = await validator(mutation.payload, mutation.collection);
+      if (!result.valid) {
+        events.emit("error", new OfflineValidationError(result.issues));
+      }
+    });
+  }
+});
+var assertValid = async (validator, record, collection) => {
+  if (!validator) {
+    return { issues: [], valid: true };
+  }
+  const result = await validator(record, collection);
+  if (!result.valid) {
+    throw new OfflineValidationError(result.issues);
+  }
+  return result;
+};
+
+export { OfflineValidationError, assertValid, composeValidators, createRequiredFieldsValidator, createTypeValidator, createValidatedStorage, validationPlugin };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;AAaO,IAAM,sBAAA,GAAN,cAAqC,KAAA,CAAM;AAAA,EACvC,MAAA;AAAA,EAET,YAAY,MAAA,EAA2B;AACrC,IAAA,KAAA,CAAM,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU,KAAA,CAAM,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA,IAAK,mBAAmB,CAAA;AAC5E,IAAA,IAAA,CAAK,IAAA,GAAO,wBAAA;AACZ,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AACF;AAIO,IAAM,6BAAA,GACX,CAAC,MAAA,KACD,CAAC,MAAA,KAAW;AACV,EAAA,MAAM,SAAS,MAAA,CACZ,MAAA,CAAO,CAAC,KAAA,KAAU,OAAO,KAAK,CAAA,KAAM,MAAA,IAAa,MAAA,CAAO,KAAK,CAAA,KAAM,IAAI,CAAA,CACvE,GAAA,CAAI,CAAC,KAAA,MAAW;AAAA,IACf,IAAA,EAAM,UAAA;AAAA,IACN,OAAA,EAAS,IAAI,KAAK,CAAA,aAAA,CAAA;AAAA,IAClB,IAAA,EAAM,CAAC,KAAK;AAAA,GACd,CAAE,CAAA;AAEJ,EAAA,OAAO,EAAE,MAAA,EAAQ,KAAA,EAAO,MAAA,CAAO,WAAW,CAAA,EAAE;AAC9C;AAEK,IAAM,mBAAA,GACX,CAAC,UAAA,KACD,CAAC,MAAA,KAAW;AACV,EAAA,MAAM,SAA4B,EAAC;AAEnC,EAAA,KAAA,MAAW,CAAC,KAAA,EAAO,YAAY,KAAK,MAAA,CAAO,OAAA,CAAQ,UAAU,CAAA,EAAG;AAC9D,IAAA,MAAM,KAAA,GAAQ,OAAO,KAAK,CAAA;AAC1B,IAAA,IAAI,KAAA,KAAU,MAAA,IAAa,KAAA,KAAU,IAAA,EAAM;AACzC,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,WAAW,OAAO,KAAA;AAC5D,IAAA,IAAI,eAAe,YAAA,EAAc;AAC/B,MAAA,MAAA,CAAO,IAAA,CAAK;AAAA,QACV,IAAA,EAAM,MAAA;AAAA,QACN,OAAA,EAAS,CAAA,CAAA,EAAI,KAAK,CAAA,kBAAA,EAAqB,YAAY,CAAA,CAAA;AAAA,QACnD,IAAA,EAAM,CAAC,KAAK;AAAA,OACb,CAAA;AAAA,IACH;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,MAAA,EAAQ,KAAA,EAAO,MAAA,CAAO,WAAW,CAAA,EAAE;AAC9C;AAEK,IAAM,iBAAA,GACX,CAAA,GAAI,UAAA,KACJ,OAAO,QAAQ,UAAA,KAAe;AAC5B,EAAA,MAAM,SAA4B,EAAC;AAEnC,EAAA,KAAA,MAAW,aAAa,UAAA,EAAY;AAClC,IAAA,MAAM,MAAA,GAAS,MAAM,SAAA,CAAU,MAAA,EAAQ,UAAU,CAAA;AACjD,IAAA,MAAA,CAAO,IAAA,CAAK,GAAG,MAAA,CAAO,MAAM,CAAA;AAAA,EAC9B;AAEA,EAAA,OAAO,EAAE,MAAA,EAAQ,KAAA,EAAO,MAAA,CAAO,WAAW,CAAA,EAAE;AAC9C;AAEK,IAAM,sBAAA,GAAyB,CACpC,OAAA,EACA,UAAA,KACmB;AACnB,EAAA,MAAM,oBAAA,GAAuB,CAAC,KAAA,MAA+C;AAAA,IAC3E,KAAA,EAAO,CAAC,UAAA,KAAe,KAAA,CAAM,MAAM,UAAU,CAAA;AAAA,IAC7C,QAAQ,CAAC,UAAA,EAAY,OAAO,KAAA,CAAM,MAAA,CAAO,YAAY,EAAE,CAAA;AAAA,IACvD,MAAM,CAA+B,UAAA,EAAoB,UACvD,KAAA,CAAM,IAAA,CAAK,YAAY,KAAK,CAAA;AAAA,IAC9B,KAAK,CAA+B,UAAA,EAAoB,OACtD,KAAA,CAAM,GAAA,CAAI,YAAY,EAAE,CAAA;AAAA,IAC1B,MAAM,GAAA,CAAI,UAAA,EAAoB,KAAA,EAAoC;AAChE,MAAA,MAAM,WAAA,CAAY,UAAA,CAAW,UAAU,CAAA,EAAG,OAAO,UAAU,CAAA;AAC3D,MAAA,MAAM,KAAA,CAAM,GAAA,CAAI,UAAA,EAAY,KAAK,CAAA;AAAA,IACnC;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,OAAA,GAA0B;AAAA,IAC9B,IAAA,EAAM,CAAA,EAAG,OAAA,CAAQ,IAAI,CAAA,UAAA,CAAA;AAAA,IACrB,eAAA,EAAiB,gCAAA;AAAA,IACjB,GAAI,QAAQ,YAAA,GAAe,EAAE,cAAc,OAAA,CAAQ,YAAA,KAAiB,EAAC;AAAA,IACrE,KAAA,EAAO,CAAC,UAAA,KAAe,OAAA,CAAQ,MAAM,UAAU,CAAA;AAAA,IAC/C,QAAQ,CAAC,UAAA,EAAY,OAAO,OAAA,CAAQ,MAAA,CAAO,YAAY,EAAE,CAAA;AAAA,IACzD,MAAM,CACJ,UAAA,EACA,UACuB,OAAA,CAAQ,IAAA,CAAK,YAAY,KAAK,CAAA;AAAA,IACvD,KAAK,CAA+B,UAAA,EAAoB,OACtD,OAAA,CAAQ,GAAA,CAAI,YAAY,EAAE,CAAA;AAAA,IAC5B,MAAM,GAAA,CAAI,UAAA,EAAoB,KAAA,EAAoC;AAChE,MAAA,MAAM,WAAA,CAAY,UAAA,CAAW,UAAU,CAAA,EAAG,OAAO,UAAU,CAAA;AAC3D,MAAA,MAAM,OAAA,CAAQ,GAAA,CAAI,UAAA,EAAY,KAAK,CAAA;AAAA,IACrC,CAAA;AAAA,IACA,WAAA,EAAa,CAAS,KAAA,EAAiB,GAAA,KACrC,OAAA,CAAQ,WAAA,CAAY,KAAA,EAAO,CAAC,KAAA,KAAU,GAAA,CAAI,oBAAA,CAAqB,KAAK,CAAC,CAAC,CAAA;AAAA,IACxE,GAAI,OAAA,CAAQ,OAAA,GAAU,EAAE,OAAA,EAAS,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,OAAO,CAAA,EAAE,GAAI;AAAC,GACtE;AAEA,EAAA,OAAO,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAC7C;AAEO,IAAM,gBAAA,GAAmB,CAAC,UAAA,MAA6C;AAAA,EAC5E,IAAA,EAAM,YAAA;AAAA,EACN,KAAA,CAAM,EAAE,MAAA,EAAO,EAAG;AAChB,IAAA,OAAO,MAAA,CAAO,EAAA,CAAG,WAAA,EAAa,OAAO,QAAA,KAAa;AAChD,MAAA,MAAM,SAAA,GAAY,UAAA,CAAW,QAAA,CAAS,UAAU,CAAA;AAEhD,MAAA,IAAI,CAAC,SAAA,IAAa,CAAC,QAAA,CAAS,OAAA,EAAS;AACnC,QAAA;AAAA,MACF;AAEA,MAAA,MAAM,SAAS,MAAM,SAAA,CAAU,QAAA,CAAS,OAAA,EAAS,SAAS,UAAU,CAAA;AAEpE,MAAA,IAAI,CAAC,OAAO,KAAA,EAAO;AACjB,QAAA,MAAA,CAAO,KAAK,OAAA,EAAS,IAAI,sBAAA,CAAuB,MAAA,CAAO,MAAM,CAAC,CAAA;AAAA,MAChE;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AACF,CAAA;AAEO,IAAM,WAAA,GAAc,OACzB,SAAA,EACA,MAAA,EACA,UAAA,KAC8B;AAC9B,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,OAAO,EAAE,MAAA,EAAQ,EAAC,EAAG,OAAO,IAAA,EAAK;AAAA,EACnC;AAEA,EAAA,MAAM,MAAA,GAAS,MAAM,SAAA,CAAU,MAAA,EAAQ,UAAU,CAAA;AAEjD,EAAA,IAAI,CAAC,OAAO,KAAA,EAAO;AACjB,IAAA,MAAM,IAAI,sBAAA,CAAuB,MAAA,CAAO,MAAM,CAAA;AAAA,EAChD;AAEA,EAAA,OAAO,MAAA;AACT","file":"index.js","sourcesContent":["import {\n  STORAGE_ADAPTER_CONTRACT_VERSION,\n  type EntityRecord,\n  type OfflinePlugin,\n  type QueryOptions,\n  type SchemaValidator,\n  type StorageAdapter,\n  type TransactionStore,\n  type ValidationIssue,\n  type ValidationResult\n} from \"@offlinejs/types\";\nimport { withIndexForwarding } from \"@offlinejs/utils\";\n\nexport class OfflineValidationError extends Error {\n  readonly issues: ValidationIssue[];\n\n  constructor(issues: ValidationIssue[]) {\n    super(issues.map((issue) => issue.message).join(\"; \") || \"Validation failed\");\n    this.name = \"OfflineValidationError\";\n    this.issues = issues;\n  }\n}\n\nexport type ValidatorMap = Record<string, SchemaValidator>;\n\nexport const createRequiredFieldsValidator =\n  (fields: string[]): SchemaValidator =>\n  (record) => {\n    const issues = fields\n      .filter((field) => record[field] === undefined || record[field] === null)\n      .map((field) => ({\n        code: \"required\",\n        message: `\"${field}\" is required`,\n        path: [field]\n      }));\n\n    return { issues, valid: issues.length === 0 };\n  };\n\nexport const createTypeValidator =\n  (fieldTypes: Record<string, \"string\" | \"number\" | \"boolean\" | \"object\">): SchemaValidator =>\n  (record) => {\n    const issues: ValidationIssue[] = [];\n\n    for (const [field, expectedType] of Object.entries(fieldTypes)) {\n      const value = record[field];\n      if (value === undefined || value === null) {\n        continue;\n      }\n\n      const actualType = Array.isArray(value) ? \"object\" : typeof value;\n      if (actualType !== expectedType) {\n        issues.push({\n          code: \"type\",\n          message: `\"${field}\" must be of type ${expectedType}`,\n          path: [field]\n        });\n      }\n    }\n\n    return { issues, valid: issues.length === 0 };\n  };\n\nexport const composeValidators =\n  (...validators: SchemaValidator[]): SchemaValidator =>\n  async (record, collection) => {\n    const issues: ValidationIssue[] = [];\n\n    for (const validator of validators) {\n      const result = await validator(record, collection);\n      issues.push(...result.issues);\n    }\n\n    return { issues, valid: issues.length === 0 };\n  };\n\nexport const createValidatedStorage = (\n  storage: StorageAdapter,\n  validators: ValidatorMap\n): StorageAdapter => {\n  const createValidatedStore = (store: TransactionStore): TransactionStore => ({\n    clear: (collection) => store.clear(collection),\n    delete: (collection, id) => store.delete(collection, id),\n    find: <TRecord extends EntityRecord>(collection: string, query?: QueryOptions<TRecord>) =>\n      store.find(collection, query),\n    get: <TRecord extends EntityRecord>(collection: string, id: string) =>\n      store.get(collection, id),\n    async set(collection: string, value: EntityRecord): Promise<void> {\n      await assertValid(validators[collection], value, collection);\n      await store.set(collection, value);\n    }\n  });\n\n  const wrapper: StorageAdapter = {\n    name: `${storage.name}:validated`,\n    contractVersion: STORAGE_ADAPTER_CONTRACT_VERSION,\n    ...(storage.capabilities ? { capabilities: storage.capabilities } : {}),\n    clear: (collection) => storage.clear(collection),\n    delete: (collection, id) => storage.delete(collection, id),\n    find: <TRecord extends EntityRecord>(\n      collection: string,\n      query?: QueryOptions<TRecord>\n    ): Promise<TRecord[]> => storage.find(collection, query),\n    get: <TRecord extends EntityRecord>(collection: string, id: string): Promise<TRecord | null> =>\n      storage.get(collection, id),\n    async set(collection: string, value: EntityRecord): Promise<void> {\n      await assertValid(validators[collection], value, collection);\n      await storage.set(collection, value);\n    },\n    transaction: <TValue>(scope: string[], run: (store: TransactionStore) => Promise<TValue>) =>\n      storage.transaction(scope, (store) => run(createValidatedStore(store))),\n    ...(storage.migrate ? { migrate: storage.migrate.bind(storage) } : {})\n  };\n\n  return withIndexForwarding(wrapper, storage);\n};\n\nexport const validationPlugin = (validators: ValidatorMap): OfflinePlugin => ({\n  name: \"validation\",\n  setup({ events }) {\n    return events.on(\"queue:add\", async (mutation) => {\n      const validator = validators[mutation.collection];\n\n      if (!validator || !mutation.payload) {\n        return;\n      }\n\n      const result = await validator(mutation.payload, mutation.collection);\n\n      if (!result.valid) {\n        events.emit(\"error\", new OfflineValidationError(result.issues));\n      }\n    });\n  }\n});\n\nexport const assertValid = async (\n  validator: SchemaValidator | undefined,\n  record: EntityRecord,\n  collection: string\n): Promise<ValidationResult> => {\n  if (!validator) {\n    return { issues: [], valid: true };\n  }\n\n  const result = await validator(record, collection);\n\n  if (!result.valid) {\n    throw new OfflineValidationError(result.issues);\n  }\n\n  return result;\n};\n"]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@offlinejs/validation",
+  "version": "0.1.0",
+  "description": "Schema validation helpers and storage wrapper for OfflineJS.",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@offlinejs/utils": "0.1.0",
+    "@offlinejs/types": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "latest",
+    "typescript": "latest"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
+  }
+}