dreamit-de
diff --git a/‎.github/dependabot.yml
Copy file name to clipboard
+13Lines changed: 13 additions & 0 deletions b/‎.github/dependabot.yml
Copy file name to clipboard
+13Lines changed: 13 additions & 0 deletions
diff --git a/‎.github/workflows/ci.yaml
Copy file name to clipboard
+31Lines changed: 31 additions & 0 deletions b/‎.github/workflows/ci.yaml
Copy file name to clipboard
+31Lines changed: 31 additions & 0 deletions
diff --git a/‎.gitignore
Copy file name to clipboard
+3Lines changed: 3 additions & 0 deletions b/‎.gitignore
Copy file name to clipboard
+3Lines changed: 3 additions & 0 deletions
diff --git a/‎GraphQLStandardSchema.ts
Copy file name to clipboard
+165Lines changed: 165 additions & 0 deletions b/‎GraphQLStandardSchema.ts
Copy file name to clipboard
+165Lines changed: 165 additions & 0 deletions
diff --git a/‎GraphQLStandardSchema_test.ts
Copy file name to clipboard
+127Lines changed: 127 additions & 0 deletions b/‎GraphQLStandardSchema_test.ts
Copy file name to clipboard
+127Lines changed: 127 additions & 0 deletions
diff --git a/‎README.md
Copy file name to clipboard
+16Lines changed: 16 additions & 0 deletions b/‎README.md
Copy file name to clipboard
+16Lines changed: 16 additions & 0 deletions
@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
@@ -0,0 +1,31 @@
+name: GraphQLStandardSchema
+on:
+  push:
+
+jobs:
+  gqlstdschema:
+    name: Install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: '2.1.9'
+      - name: Cache https://
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/deno/deps/https
+          key: deno-https/v1-${{ github.sha }}
+          restore-keys: deno-https/v1-
+      - run: deno task lint
+      - run: deno task coverage
+      - name: Get tag version
+        if: startsWith(github.ref, 'refs/tags/')
+        id: get_tag_version
+        run: echo TAG_VERSION=${GITHUB_REF/refs\/tags\//} >> $GITHUB_OUTPUT
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm build
+        run: deno run -A ./scripts/build_npm.ts ${{steps.get_tag_version.outputs.TAG_VERSION}}
@@ -0,0 +1,3 @@
+.vscode/settings.json
+npm/
+covresults
@@ -0,0 +1,165 @@
+import type { StandardSchemaV1 } from './StandardSchemaV1.ts'
+
+export interface ValidationOptions {
+   /**
+    * In a GraphQL response only the fields "data", "errors" and "extensions" are allowed. When set to true
+    * this checks allows additional fields. According to GraphQL spec October 2021 this should not be the case.
+    */
+   allowAdditionalFieldsInResponse?: boolean
+
+   /**
+    * Defines if both "errors" and "data" fields are allowed in the response.
+    * According to GraphQL spec October 2021 this should not be the case.
+    */
+   allowBothErrorsAndDataFields?: boolean
+
+   /**
+    * If value is a string, define if it should be parsed to an object. Otherwise an issue will be created.
+    */
+   parseStringToObject?: boolean
+}
+
+/**
+ * Checks for issues in the response object with the given options
+ * @param {any} response - The response object
+ * @param {ValidationOptions} options -  The optional validation options for the schema validation
+ * @returns
+ */
+export function findIssues(
+   // deno-lint-ignore no-explicit-any
+   response: any,
+   options?: ValidationOptions,
+): StandardSchemaV1.Issue[] {
+   const foundIssues: StandardSchemaV1.Issue[] = []
+
+   if (!response.data && !response.errors) {
+      foundIssues.push({
+         message:
+            'GraphQL response should contain at least one of data or error field, but both are missing.',
+      })
+   } else if (
+      response.data && response.errors &&
+      (!options || !options.allowBothErrorsAndDataFields)
+   ) {
+      foundIssues.push({
+         message:
+            'GraphQL response contains both data and errors fields but should contain only one of them.',
+      })
+   }
+
+   if (
+      response.data && response.data !== null &&
+      typeof response.data !== 'object'
+   ) {
+      foundIssues.push({
+         message:
+            `GraphQL response contains "data" field of type "${typeof response
+               .data}" but "data" should be an "object".`,
+      })
+   }
+
+   if (
+      response.errors &&
+      !Array.isArray(response.errors)
+   ) {
+      foundIssues.push({
+         message:
+            `GraphQL response contains "errors" field of type "${typeof response
+               .errors}" but "errors" should be an "array".`,
+      })
+   }
+
+   if (
+      response.errors &&
+      Array.isArray(response.errors) &&
+      response.errors.length < 1
+   ) {
+      foundIssues.push({
+         message:
+            'GraphQL response contains empty "errors" field but should at least have one error entry.',
+      })
+   }
+
+   if (
+      response.extensions &&
+      typeof response.extensions !== 'object'
+   ) {
+      foundIssues.push({
+         message:
+            `GraphQL response contains "extensions" field of type "${typeof response
+               .extensions}" but "extensions" should be an "object".`,
+      })
+   }
+
+   if (!options || !options.allowAdditionalFieldsInResponse) {
+      const additionalProperties = Object.getOwnPropertyNames(
+         response,
+      ).filter((property) =>
+         property !== 'data' && property !== 'errors' &&
+         property !== 'extensions'
+      )
+      if (additionalProperties.length > 0) {
+         foundIssues.push({
+            message:
+               `GraphQL response should contain only "data", "errors" or "extensions" fields but has the following fields: "${additionalProperties}".`,
+         })
+      }
+   }
+   return foundIssues
+}
+
+/**
+ * Creates a GraphQL response schema
+ * @param {ValidationOptions} options - The optional validation options for the schema validation
+ * @returns {StandardSchemaV1<object>} The GraphQL response Standard Schema
+ */
+export function graphQLResponseSchema(
+   options?: ValidationOptions,
+): StandardSchemaV1<object | string> {
+   return {
+      '~standard': {
+         version: 1,
+         vendor: 'dreamit',
+         validate(value) {
+            /*
+             * Check type of value. If value is a string and parseStringToObject option is enabled try to parse it
+             * to an object so we can check if. If it is neither an object nor a string return an issue.
+             */
+            let responseAsObject
+            if (typeof value === 'string') {
+               if (!options || !options.parseStringToObject) {
+                  return {
+                     issues: [
+                        {
+                           message:
+                              'Provided value is a string and "parseStringToObject" option is disabled',
+                        },
+                     ],
+                  }
+               } else {
+                  try {
+                     responseAsObject = JSON.parse(value)
+                  } catch (error) {
+                     return {
+                        issues: [
+                           {
+                              message:
+                                 `String value could not be parsed to object. Error is ${error}`,
+                           },
+                        ],
+                     }
+                  }
+               }
+            } else if (typeof value === 'object') {
+               responseAsObject = value
+            }
+
+            const foundIssues = findIssues(responseAsObject, options)
+
+            return foundIssues.length > 0
+               ? { issues: foundIssues }
+               : { value: responseAsObject }
+         },
+      },
+   }
+}
@@ -0,0 +1,127 @@
+import { findIssues, graphQLResponseSchema } from './GraphQLStandardSchema.ts'
+import { assertEquals, assertRejects } from '@std/assert'
+import type { StandardSchemaV1 } from './StandardSchemaV1.ts'
+
+// Helper function from https://standardschema.dev/ to validate an input
+export async function standardValidate<T extends StandardSchemaV1>(
+   schema: T,
+   input: StandardSchemaV1.InferInput<T>,
+): Promise<StandardSchemaV1.InferOutput<T>> {
+   let result = schema['~standard'].validate(input)
+   if (result instanceof Promise) result = await result
+
+   // if the `issues` field exists, the validation failed
+   if (result.issues) {
+      throw new Error(JSON.stringify(result.issues, null, 2))
+   }
+
+   return result.value
+}
+
+Deno.test('GraphQLStandardSchema should work as expected when no options are provided', async () => {
+   const schema = graphQLResponseSchema()
+
+   assertEquals(schema['~standard'].vendor, 'dreamit')
+   assertEquals(schema['~standard'].version, 1)
+
+   // Case: Value is a string and parseStringToObject is false
+   await assertRejects(
+      async () => {
+         await standardValidate(schema, 'string')
+      },
+      Error,
+      'Provided value is a string and \\"parseStringToObject\\" option is disabled',
+   )
+
+   // Case: Value is an object but undefined
+   await assertRejects(
+      async () => {
+         await standardValidate(schema, {})
+      },
+      Error,
+      'GraphQL response should contain at least one of data or error field, but both are missing.',
+   )
+
+   // Case: Data is set and valid
+   assertEquals(
+      await standardValidate(schema, { data: { message: 'OK' } }),
+      { data: { message: 'OK' } },
+   )
+})
+
+Deno.test('GraphQLStandardSchema should work as expected when parseStringToObject is enabled', async () => {
+   const schema = graphQLResponseSchema({ parseStringToObject: true })
+
+   // Case: Value is a string and parseStringToObject is false
+   await assertRejects(
+      async () => {
+         await standardValidate(schema, 'string')
+      },
+      Error,
+      'String value could not be parsed to object. Error is SyntaxError: Unexpected token \'s\', \\"string\\" is not valid JSON"',
+   )
+})
+
+Deno.test('findIssues should find expected issues', () => {
+   // Case: Both data and errors missing
+   assertEquals(
+      findIssues({}).at(0)?.message,
+      'GraphQL response should contain at least one of data or error field, but both are missing.',
+   )
+
+   // Case: Both data and errors set and allowBothErrorsAndDataFields is false
+   assertEquals(
+      findIssues({ data: { message: 'data' }, errors: ['errors'] }).at(0)
+         ?.message,
+      'GraphQL response contains both data and errors fields but should contain only one of them.',
+   )
+   // Case: Both data and errors set and allowBothErrorsAndDataFields is true
+   assertEquals(
+      findIssues({ data: { message: 'data' }, errors: ['errors'] }, {
+         allowBothErrorsAndDataFields: true,
+      }).length,
+      0,
+   )
+
+   // Case: Errors is set but empty
+   assertEquals(
+      findIssues({ errors: [] }).at(0)
+         ?.message,
+      'GraphQL response contains empty "errors" field but should at least have one error entry.',
+   )
+
+   // Case: Data is set but not an object
+   assertEquals(
+      findIssues({ data: 'string' }).at(0)
+         ?.message,
+      'GraphQL response contains "data" field of type "string" but "data" should be an "object".',
+   )
+
+   // Case: Data is set but not an object
+   assertEquals(
+      findIssues({ errors: 'string' }).at(0)
+         ?.message,
+      'GraphQL response contains "errors" field of type "string" but "errors" should be an "array".',
+   )
+
+   // Case: Extensions is set but not an object
+   assertEquals(
+      findIssues({ data: {}, extensions: 'string' }).at(0)
+         ?.message,
+      'GraphQL response contains "extensions" field of type "string" but "extensions" should be an "object".',
+   )
+
+   // Case: Additional field myCustomField is set and allowAdditionalFieldsInResponse is false
+   assertEquals(
+      findIssues({ data: {}, myCustomField: 'string' }).at(0)
+         ?.message,
+      'GraphQL response should contain only "data", "errors" or "extensions" fields but has the following fields: "myCustomField".',
+   )
+   // Case: Additional field myCustomField is set and allowAdditionalFieldsInResponse is true
+   assertEquals(
+      findIssues({ data: {}, myCustomField: 'string' }, {
+         allowAdditionalFieldsInResponse: true,
+      }).length,
+      0,
+   )
+})
@@ -1,2 +1,18 @@
 # graphql-std-schema
+
 Standard Schema for GraphQL response
+
+## Run
+
+Only tests are executable. To run tests execute **deno test**.
+
+## Lint
+
+To check for linting issues execute **deno lint**.
+
+## Build npm library
+
+To build an npm library execute **deno run -A scripts/build_npm.ts 0.0.1**
+replacing 0.0.1 with the version you wish to build. Library will be located in
+"/npm" folder. Run **npm pack** in npm folder to create a tar archive of the
+library and add them to the projects you want to use the PersonService in.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.vscode/settings.json`
	`2`	`+npm/`
	`3`	`+covresults`