feat(data-exchange-standard): moving standard schema to library

apps/form-service/tsconfig.spec.json

@@ -3,8 +3,7 @@
   "compilerOptions": {
     "outDir": "../../dist/out-tsc",
     "module": "commonjs",
-    "types": ["jest", "node"],
-    "resolveJsonModule": true
+    "types": ["jest", "node"]
   },
   "include": [
     "**/*.spec.ts",

apps/tenant-management-webapp/project.json

@@ -28,7 +28,7 @@
           },
           {
             "glob": "standard.*.schema.json",
-            "input": "apps/form-service/src",
+            "input": "libs/data-exchange-standard/src",
             "output": "./"
           }
         ],

libs/core-common/src/jsonSchema/ajv.ts

@@ -1,3 +1,4 @@
+import { standardJsonSchema } from '@abgov/data-exchange-standard';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
 import * as schemaMigration from 'json-schema-migrate';
@@ -12,6 +13,8 @@ export class AjvValidationService implements ValidationService {
   constructor(private logger: Logger) {
     this.ajv.addFormat('file-urn', /^urn:ads:platform:file-service:v[0-9]:\/files\/[a-zA-Z0-9.-]*$/);
     addFormats(this.ajv);
+
+    this.ajv.addSchema(standardJsonSchema);
   }
 
   setSchema(schemaKey: string, schema: Record<string, unknown>): void {

libs/data-exchange-standard/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/data-exchange-standard/README.md

@@ -0,0 +1,7 @@
+# data-exchange-standard
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test data-exchange-standard` to execute the unit tests via [Jest](https://jestjs.io).

libs/data-exchange-standard/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'data-exchange-standard',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/data-exchange-standard',
+};

libs/data-exchange-standard/project.json

@@ -0,0 +1,19 @@
+{
+  "name": "data-exchange-standard",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/data-exchange-standard/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/data-exchange-standard/jest.config.ts"
+      }
+    }
+  }
+}

libs/data-exchange-standard/src/index.ts

@@ -0,0 +1,3 @@
+import * as standardJsonSchema from './standard.v1.schema.json';
+
+export { standardJsonSchema };

apps/form-service/src/standard.v1.schema.json → libs/data-exchange-standard/src/standard.v1.schema.json

@@ -14,8 +14,9 @@
   "type": "object",
   "properties": {
     "postalAddress": {
-      "id": "#postalAddress",
+      "$id": "#postalAddress",
       "description": "Address line contains the primary address number, predirectional information, street name, suffix, postdirectional information, secondary address identifier and/or secondary address.The address line can contain information for a civic, rural, or postal box address.",
+      "type": "object",
       "properties": {
         "addressLine1": {
           "$ref": "#/$defs/addressLine"
@@ -59,8 +60,9 @@
       "required": [
         "address1",
         "subdivisionCode",
-        "postalCode"
+        "postalCode",
+        "country"
       ]
     }
   }
-}
+}

libs/data-exchange-standard/src/standard.v1.schema.spec.ts

@@ -0,0 +1,44 @@
+import Ajv from 'ajv';
+import * as standard from './standard.v1.schema.json';
+
+describe('standard.schema.v1', () => {
+  it('is valid json schema', () => {
+    const ajv = new Ajv({ allErrors: true, verbose: true, strict: 'log' });
+    const result = ajv.validateSchema(standard);
+    expect(result).toBe(true);
+  });
+
+  it('can be referenced to validate', () => {
+    const ajv = new Ajv({ allErrors: true, verbose: true, strict: 'log' });
+    ajv.addSchema(standard);
+    ajv.addSchema(
+      {
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        type: 'object',
+        properties: {
+          address: { $ref: 'https:/adsp.alberta.ca/standard.v1.schema.json#postalAddress' },
+        },
+      },
+      'form'
+    );
+
+    let result = ajv.validate('form', {
+      address: {
+        address1: '123 fake st.',
+        subdivisionCode: 'AB',
+        postalCode: 'T1A 4L1',
+        country: 'CA',
+      },
+    });
+    expect(result).toBe(true);
+
+    result = ajv.validate('form', {
+      address: {
+        subdivisionCode: 'AB',
+        postalCode: 'T1A 4L1',
+        country: 'CA',
+      },
+    });
+    expect(result).toBe(false);
+  });
+});

libs/data-exchange-standard/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/data-exchange-standard/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

libs/data-exchange-standard/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}

tsconfig.base.json

@@ -12,11 +12,13 @@
     "module": "esnext",
     "typeRoots": ["node_modules/@types"],
     "lib": ["es2017", "dom"],
+    "resolveJsonModule": true,
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
     "baseUrl": ".",
     "paths": {
       "@abgov/adsp-service-sdk": ["libs/adsp-service-sdk/src/index.ts"],
+      "@abgov/data-exchange-standard": ["libs/data-exchange-standard/src/index.ts"],
       "@abgov/jsonforms-components": ["libs/jsonforms-components/src/index.ts"],
       "@core-services/app-common": ["libs/app-common/src/index.ts"],
       "@core-services/core-common": ["libs/core-common/src/index.ts"],