feat!: init readonly field validators

.changeset/selfish-cows-smash.md

@@ -0,0 +1,5 @@
+---
+"typesync-cli": minor
+---
+
+[BREAKING] Renamed the `validatorNamePattern` option for the `generate-rules` command to `typeValidatorNamePattern`.

.changeset/wicked-goats-type.md

@@ -0,0 +1,5 @@
+---
+"typesync-cli": minor
+---
+
+[BREAKING] Renamed the `validatorParamName` option for the `generate-rules` command to `typeValidatorParamName`.

.circleci/config.yml

@@ -99,9 +99,10 @@ jobs:
       - run:
           name: Run rests for the source code
           command: yarn test:src
-      - run:
-          name: Run Security Rules tests
-          command: yarn test:rules
+      # TODO: Implement
+      # - run:
+      #     name: Run Security Rules tests
+      #     command: yarn test:rules
 
   publish-npm-package:
     executor: node/default

package.json

@@ -44,11 +44,12 @@
     "format-check:src": "prettier \"src/**/*.(js|ts|json)\" --check",
     "format:package-json": "sort-package-json \"package.json\"",
     "format:src": "prettier --write \"src/**/*.(js|ts|json)\"",
-    "generate-json-schema": "tsx scripts/generate-json-schema",
+    "generate-json-schema": "tsx scripts/generate-json-schema current-version",
+    "generate-json-schema-local": "tsx scripts/generate-json-schema local",
     "lint": "eslint src --ext .ts",
     "test": "yarn run test:compile && yarn run test:src --verbose && yarn run test:rules",
     "test:compile": "tsc -p tsconfig.test.json",
-    "test:rules": "firebase emulators:exec --project demo-rules --only firestore 'jest --testMatch \"<rootDir>/tests/security/**/*.test.ts\"'",
+    "test:rules": "tsx src/cli/index.tsx generate-rules --definition tests/security/definition.yml --outFile tests/security/firestore.rules && firebase emulators:exec --project demo-rules --only firestore 'jest --testMatch \"<rootDir>/tests/security/**/*.test.ts\"'",
     "test:src": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "version": "changeset version && yarn run generate-json-schema"
   },

scripts/generate-json-schema.ts

@@ -3,7 +3,7 @@ import { format } from 'prettier';
 import { zodToJsonSchema } from 'zod-to-json-schema';
 
 import { definition } from '../src/definition/index.js';
-import { assert } from '../src/util/assert.js';
+import { assert, assertNever } from '../src/util/assert.js';
 import { extractPackageJsonVersion } from '../src/util/extract-package-json-version.js';
 import { getDirName, writeFile } from '../src/util/fs.js';
 
@@ -14,8 +14,8 @@ function inferCurrentSchemaVersion() {
   return `v${major}.${minor}`;
 }
 
-function generateJsonSchema(minorVersionName: string) {
-  return zodToJsonSchema(definition.zodSchema, minorVersionName);
+function generateJsonSchema(name: string) {
+  return zodToJsonSchema(definition.zodSchema, name);
 }
 
 type JsonSchema = ReturnType<typeof generateJsonSchema>;
@@ -30,9 +30,27 @@ async function writeJsonSchemaToFile(jsonSchema: JsonSchema, outPath: string) {
 }
 
 async function main() {
-  const minorVersionName = inferCurrentSchemaVersion();
-  const jsonSchema = generateJsonSchema(minorVersionName);
-  const pathToOutputFile = resolve(getDirName(import.meta.url), `../public/${minorVersionName}.json`);
+  const [, , type] = process.argv;
+  assert(
+    type === 'current-version' || type === 'local',
+    `The 'type' argument for generate-json-schema must be one of 'current-version' or 'local'.`
+  );
+
+  let schemaName: string | undefined;
+  let pathToOutputFile: string | undefined;
+
+  if (type === 'current-version') {
+    const minorVersionName = inferCurrentSchemaVersion();
+    schemaName = minorVersionName;
+    pathToOutputFile = resolve(getDirName(import.meta.url), `../public/${minorVersionName}.json`);
+  } else if (type === 'local') {
+    schemaName = 'local';
+    pathToOutputFile = resolve(getDirName(import.meta.url), `../schema.local.json`);
+  } else {
+    assertNever(type);
+  }
+
+  const jsonSchema = generateJsonSchema(schemaName);
   await writeJsonSchemaToFile(jsonSchema, pathToOutputFile);
 }
 

src/api/rules.ts

@@ -3,15 +3,18 @@ import { GenerateRepresentationResult } from './_common.js';
 
 export interface GenerateRulesRepresentationOptions {
   definition: string;
+  typeValidatorNamePattern?: string;
+  typeValidatorParamName?: string;
+  readonlyFieldValidatorNamePattern?: string;
+  readonlyFieldValidatorPrevDataParamName?: string;
+  readonlyFieldValidatorNextDataParamName?: string;
   debug?: boolean;
 }
 
 export interface GenerateRulesOptions extends GenerateRulesRepresentationOptions {
   outFile: string;
   startMarker?: string;
   endMarker?: string;
-  validatorNamePattern?: string;
-  validatorParamName?: string;
   indentation?: number;
 }
 

src/cli/index.tsx

@@ -19,16 +19,20 @@ import {
   DEFAULT_RULES_DEBUG,
   DEFAULT_RULES_END_MARKER,
   DEFAULT_RULES_INDENTATION,
+  DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN,
+  DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NEXT_DATA_PARAM_NAME,
+  DEFAULT_RULES_READONLY_FIELD_VALIDATOR_PREV_DATA_PARAM_NAME,
   DEFAULT_RULES_START_MARKER,
-  DEFAULT_RULES_VALIDATOR_NAME_PATTERN,
-  DEFAULT_RULES_VALIDATOR_PARAM_NAME,
+  DEFAULT_RULES_TYPE_VALIDATOR_NAME_PATTERN,
+  DEFAULT_RULES_TYPE_VALIDATOR_PARAM_NAME,
   DEFAULT_SWIFT_DEBUG,
   DEFAULT_SWIFT_INDENTATION,
   DEFAULT_TS_DEBUG,
   DEFAULT_TS_INDENTATION,
   DEFAULT_TS_OBJECT_TYPE_FORMAT,
   DEFAULT_VALIDATE_DEBUG,
-  RULES_VALIDATOR_NAME_PATTERN_PARAM,
+  RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN_PARAM,
+  RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM,
 } from '../constants.js';
 import { extractErrorMessage } from '../util/extract-error-message.js';
 import { extractPackageJsonVersion } from '../util/extract-package-json-version.js';
@@ -263,17 +267,38 @@ await yargs(hideBin(process.argv))
           demandOption: false,
           default: DEFAULT_RULES_END_MARKER,
         })
-        .option('validatorNamePattern', {
-          describe: `The pattern that specifies how the validators are named. The string must contain the '${RULES_VALIDATOR_NAME_PATTERN_PARAM}' substring (this is a literal value). For example, providing 'isValid${RULES_VALIDATOR_NAME_PATTERN_PARAM}' ensures that the generated validators are given names like 'isValidUser', 'isValidProject' etc.`,
+        .option('typeValidatorNamePattern', {
+          describe: `The pattern that specifies how the generated type validators are named. The pattern must be a string that contains the '${RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM}' substring (this is a literal value). For example, providing 'isValid${RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM}' ensures that the generated validators are given names like 'isValidUser', 'isValidProject' etc.`,
           type: 'string',
           demandOption: false,
-          default: DEFAULT_RULES_VALIDATOR_NAME_PATTERN,
+          default: DEFAULT_RULES_TYPE_VALIDATOR_NAME_PATTERN,
         })
-        .option('validatorParamName', {
+        .option('typeValidatorParamName', {
           describe: 'The name of the parameter taken by each type validator.',
           type: 'string',
           demandOption: false,
-          default: DEFAULT_RULES_VALIDATOR_PARAM_NAME,
+          default: DEFAULT_RULES_TYPE_VALIDATOR_PARAM_NAME,
+        })
+        // TODO: Implement
+        // .option('readonlyFieldValidatorNamePattern', {
+        //   describe: `The pattern that specifies how the generated readonly field validators are named. The pattern must be a string that contains the '${RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN_PARAM}' substring (this is a literal value). For example, providing 'isReadonlyFieldAffectedFor${RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN_PARAM}' ensures that the generated validators are given names like 'isReadonlyFieldAffectedForUser', 'isReadonlyFieldAffectedForProject' etc.`,
+        //   type: 'string',
+        //   demandOption: false,
+        //   default: DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN,
+        // })
+        // .option('readonlyFieldValidatorPrevDataParamName', {
+        //   describe:
+        //     'The name of the first parameter taken by each readonly field validator representing previous data. This parameter used when computing the diff between next data and previous data to determine whether a readonly field has been affected by a write.',
+        //   type: 'string',
+        //   demandOption: false,
+        //   default: DEFAULT_RULES_READONLY_FIELD_VALIDATOR_PREV_DATA_PARAM_NAME,
+        // })
+        .option('readonlyFieldValidatorNextDataParamName', {
+          describe:
+            'The name of the second parameter taken by each readonly field validator representing next data. This parameter used when computing the diff between next data and previous data to determine whether a readonly field has been affected by a write.',
+          type: 'string',
+          demandOption: false,
+          default: DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NEXT_DATA_PARAM_NAME,
         })
         .option('indentation', {
           describe: 'Indentation or tab width for the generated code.',
@@ -293,8 +318,11 @@ await yargs(hideBin(process.argv))
         outFile,
         startMarker,
         endMarker,
-        validatorNamePattern,
-        validatorParamName,
+        typeValidatorNamePattern,
+        typeValidatorParamName,
+        readonlyFieldValidatorNamePattern,
+        readonlyFieldValidatorPrevDataParamName,
+        readonlyFieldValidatorNextDataParamName,
         indentation,
         debug,
       } = args;
@@ -306,8 +334,11 @@ await yargs(hideBin(process.argv))
           outFile: pathToOutputFile,
           startMarker,
           endMarker,
-          validatorNamePattern,
-          validatorParamName,
+          typeValidatorNamePattern,
+          typeValidatorParamName,
+          // readonlyFieldValidatorNamePattern,
+          // readonlyFieldValidatorPrevDataParamName,
+          // readonlyFieldValidatorNextDataParamName,
           indentation,
           debug,
         });

src/constants.ts

@@ -2,7 +2,8 @@ import type { SchemaGraphOrientation } from './api/graph.js';
 import type { TSObjectTypeFormat } from './api/ts.js';
 
 export const PYTHON_UNDEFINED_SENTINEL_CLASS = 'TypesyncUndefined';
-export const RULES_VALIDATOR_NAME_PATTERN_PARAM = '{modelName}';
+export const RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM = '{modelName}';
+export const RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN_PARAM = '{modelName}';
 
 /*
  * Default values
@@ -21,8 +22,11 @@ export const DEFAULT_PY_DEBUG = false;
 
 export const DEFAULT_RULES_START_MARKER = 'typesync-start';
 export const DEFAULT_RULES_END_MARKER = 'typesync-end';
-export const DEFAULT_RULES_VALIDATOR_NAME_PATTERN = `isValid${RULES_VALIDATOR_NAME_PATTERN_PARAM}`;
-export const DEFAULT_RULES_VALIDATOR_PARAM_NAME = 'data';
+export const DEFAULT_RULES_TYPE_VALIDATOR_NAME_PATTERN = `isValid${RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM}`;
+export const DEFAULT_RULES_TYPE_VALIDATOR_PARAM_NAME = 'data';
+export const DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NAME_PATTERN = `isReadonlyFieldAffectedFor${RULES_TYPE_VALIDATOR_NAME_PATTERN_PARAM}`;
+export const DEFAULT_RULES_READONLY_FIELD_VALIDATOR_PREV_DATA_PARAM_NAME = 'prevData';
+export const DEFAULT_RULES_READONLY_FIELD_VALIDATOR_NEXT_DATA_PARAM_NAME = 'nextData';
 export const DEFAULT_RULES_INDENTATION = 2;
 export const DEFAULT_RULES_DEBUG = false;
 

src/core/__tests__/definitions/bad-field.json

@@ -1,5 +1,5 @@
 {
-  "bad": "../../../../public/v0.9.json",
+  "bad": "../../../../schema.local.json",
   "Username": {
     "model": "alias",
     "type": "string"

src/core/__tests__/definitions/with-$schema-key.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "../../../../public/v0.9.json",
+  "$schema": "../../../../schema.local.json",
   "Username": {
     "model": "alias",
     "type": "string"

src/core/__tests__/definitions/yaml/alias.yml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=../../../../../public/v0.9.json
+# yaml-language-server: $schema=../../../../../schema.local.json
 
 Username:
   model: alias

src/core/__tests__/definitions/yaml/document.yml

@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=../../../../../public/v0.9.json
+# yaml-language-server: $schema=../../../../../schema.local.json
 
 UserProfile:
   model: document