Milestone/v2.0.0

.github/workflows/codeql-analysis.yml

@@ -3,7 +3,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, beta ]
   pull_request:
     branches: [ main ]
   schedule:

.github/workflows/semantic-release.yml

@@ -1,7 +1,7 @@
 name: Release
 on:
   push:
-    branches: [ main, beta ]
+    branches: [ main, beta, prerelease ]
   pull_request:
     branches: [ main ]
 jobs:
@@ -10,16 +10,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           persist-credentials: false
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v3
         with:
           version: latest
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
           cache: 'pnpm'

.releaserc

@@ -4,13 +4,14 @@
 	"branches": [
 		{ "name": "main", "channel": "latest" },
 		"+([0-9])?(.{+([0-9]),x}).x",
-		{ "name": "beta", "prerelease": true }
+		{ "name": "beta", "prerelease": true },
+		{ "name": "prerelease", "prerelease": "rc" }
 	],
 	"plugins": [
 		"@semantic-release/commit-analyzer",
 		"@semantic-release/release-notes-generator",
-		"@semantic-release/github",
 		"@semantic-release/npm",
+		"@semantic-release/github",
 		["@semantic-release/changelog", {
 			"changelogFile": "CHANGELOG.md"
 		}],

CHANGELOG.md

@@ -1,158 +1,47 @@
-# [1.1.0](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.5...v1.1.0) (2024-04-22)
-
-
-### Features
-
-* update resources to schema v1.0.4 ([fbd74ca](https://github.com/commercelayer/provisioning-sdk/commit/fbd74caa90ae05253bf67080baa94c4210bdcd77))
-
-## [1.0.5](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.4...v1.0.5) (2024-03-12)
-
-
-### Bug Fixes
-
-* migrate from ts-node to tsx and update dependencies ([0243330](https://github.com/commercelayer/provisioning-sdk/commit/02433307746d7847132c7ac09a18282fb6621986))
-
-## [1.0.4](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.3...v1.0.4) (2024-03-12)
-
-
-### Bug Fixes
-
-* fix circular inclusion ([4120ec7](https://github.com/commercelayer/provisioning-sdk/commit/4120ec7f63872cbbc913fd89dba3c8f90ec28c63))
-
-## [1.0.3](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.2...v1.0.3) (2024-03-04)
-
-
-### Bug Fixes
-
-* fix import/export config ([5ba0083](https://github.com/commercelayer/provisioning-sdk/commit/5ba008381ff8a25884d1be17e2fd82e9f97e6c2b))
-
-## [1.0.2](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.1...v1.0.2) (2024-03-01)
-
-
-### Bug Fixes
-
-* fix api esm export ([ba275ff](https://github.com/commercelayer/provisioning-sdk/commit/ba275ffe5b8e92af9528efd41d69cd7091cc8d16))
-* fix env secrets ([04d6e39](https://github.com/commercelayer/provisioning-sdk/commit/04d6e393b2a4fbb7ea542a62090fe123883d5f52))
-* fix package exports ([17d9c4a](https://github.com/commercelayer/provisioning-sdk/commit/17d9c4ae01170dabd36bdc103a69017ecc07e136))
-* fix package exports ([ab753f0](https://github.com/commercelayer/provisioning-sdk/commit/ab753f0dc194b8d882562a03a5f3e5325815707f))
-* fix spot test ([b09a833](https://github.com/commercelayer/provisioning-sdk/commit/b09a83313798c871821943771b91ff1ddbbccb5c))
-* fix test env ([dff0a7a](https://github.com/commercelayer/provisioning-sdk/commit/dff0a7a79100581b47a973b39a033dfa7a10e104))
-
-## [1.0.1](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0...v1.0.1) (2024-02-27)
-
-
-### Bug Fixes
-
-* fix esm export ([50c6f7d](https://github.com/commercelayer/provisioning-sdk/commit/50c6f7d5d02b5e721b4befdadaa20e7fbf1e2718))
-
-# 1.0.0 (2024-01-26)
-
-
-### Bug Fixes
-
-* **doc:** fix readme ([50bf2b6](https://github.com/commercelayer/provisioning-sdk/commit/50bf2b6debd921e1ca4936ac5acc669b191116ac))
-* fix custom user agent option ([75f5f97](https://github.com/commercelayer/provisioning-sdk/commit/75f5f97e3dade5dd43905deba81f6c4ed46ca21b))
-* fix heading empty lines ([a24e997](https://github.com/commercelayer/provisioning-sdk/commit/a24e9976b89387f6130d4b95930aa9b65e784113))
-* fix release script and update dependencies ([a597c75](https://github.com/commercelayer/provisioning-sdk/commit/a597c7513a16d92842f7fddf74517af1fd4a0f9c))
-* fix singleton patch with body id ([e923c9c](https://github.com/commercelayer/provisioning-sdk/commit/e923c9ce69f5b5ea43698bd1df67f26783010d1e))
-* fix singleton spec ([5c617a8](https://github.com/commercelayer/provisioning-sdk/commit/5c617a8af5c7682a38e645cf86607214c4cbd1de))
-* release script ([006a747](https://github.com/commercelayer/provisioning-sdk/commit/006a74784c4f2fe302d4d4b0b96673df0067f8a1))
-* singleton import ([9578382](https://github.com/commercelayer/provisioning-sdk/commit/9578382b671629d4891e77f39658ab66828eb357))
-* update dependencies and fix lint errors ([8e39135](https://github.com/commercelayer/provisioning-sdk/commit/8e3913557a272b3b31d168b3c54ced26128ed7c3))
-* update schema ([9e569c7](https://github.com/commercelayer/provisioning-sdk/commit/9e569c7484896ea666f5f8079ee0833ed9dc87aa))
-
-
-### Features
-
-* add auto generation of special actions ([08cd9ff](https://github.com/commercelayer/provisioning-sdk/commit/08cd9ffdae53c80d7b52f841c2da319488a9ee85))
-* add custom user agent ([fe2050d](https://github.com/commercelayer/provisioning-sdk/commit/fe2050d4088adbdce4d8e30d6773ebf3fef28e3e))
-* add singleton update ([71e0e7b](https://github.com/commercelayer/provisioning-sdk/commit/71e0e7b3a10ec3210da8363ccb5bc9986a4673a1))
-* add singletons functions to client instance ([ca338e6](https://github.com/commercelayer/provisioning-sdk/commit/ca338e63574b1c0aa8301d2de2676b4e32e991cd))
-* add singletons list and functions ([5f5d4f1](https://github.com/commercelayer/provisioning-sdk/commit/5f5d4f1c8be9ae70db4765bc8e6f519597db7b17))
-* first commit of provisioning sdk ([b067f12](https://github.com/commercelayer/provisioning-sdk/commit/b067f123ed9f2e0fce53673306b05fcf479c17f0))
-* update resources to schema v1.0.1 ([686e24a](https://github.com/commercelayer/provisioning-sdk/commit/686e24ae6f3c63a2a07d9e5fac8047161d7b462c))
-* update resources to schema v1.0.2 ([87dd737](https://github.com/commercelayer/provisioning-sdk/commit/87dd7370897b65e730b69c8bed3c5e4a23de94a4))
-
-# [1.0.0-beta.11](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.10...v1.0.0-beta.11) (2024-01-10)
+# [2.0.0-rc.2](https://github.com/commercelayer/provisioning-sdk/compare/v2.0.0-rc.1...v2.0.0-rc.2) (2024-04-12)
 
 
 ### Bug Fixes
 
-* update dependencies and fix lint errors ([8e39135](https://github.com/commercelayer/provisioning-sdk/commit/8e3913557a272b3b31d168b3c54ced26128ed7c3))
+* fix jsonapi import types ([98a862b](https://github.com/commercelayer/provisioning-sdk/commit/98a862bbd721b724aeb3afa526769ef50a639e7a))
+* fix release config ([95f70c5](https://github.com/commercelayer/provisioning-sdk/commit/95f70c58701169dc0449654a4d166999c166638c))
 
-# [1.0.0-beta.10](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.9...v1.0.0-beta.10) (2023-12-20)
+# [2.0.0-rc.1](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.5...v2.0.0-rc.1) (2024-04-12)
 
 
-### Bug Fixes
-
-* fix singleton patch with body id ([e923c9c](https://github.com/commercelayer/provisioning-sdk/commit/e923c9ce69f5b5ea43698bd1df67f26783010d1e))
-
-# [1.0.0-beta.9](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.8...v1.0.0-beta.9) (2023-12-20)
-
-
-### Features
-
-* add singletons functions to client instance ([ca338e6](https://github.com/commercelayer/provisioning-sdk/commit/ca338e63574b1c0aa8301d2de2676b4e32e991cd))
-* add singletons list and functions ([5f5d4f1](https://github.com/commercelayer/provisioning-sdk/commit/5f5d4f1c8be9ae70db4765bc8e6f519597db7b17))
-
-# [1.0.0-beta.8](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.7...v1.0.0-beta.8) (2023-12-20)
-
-
-### Bug Fixes
-
-* fix singleton spec ([5c617a8](https://github.com/commercelayer/provisioning-sdk/commit/5c617a8af5c7682a38e645cf86607214c4cbd1de))
-
-
-### Features
-
-* add singleton update ([71e0e7b](https://github.com/commercelayer/provisioning-sdk/commit/71e0e7b3a10ec3210da8363ccb5bc9986a4673a1))
-
-# [1.0.0-beta.7](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.6...v1.0.0-beta.7) (2023-12-13)
-
-
-### Features
+### breaking
 
-* add auto generation of special actions ([08cd9ff](https://github.com/commercelayer/provisioning-sdk/commit/08cd9ffdae53c80d7b52f841c2da319488a9ee85))
-
-# [1.0.0-beta.6](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.5...v1.0.0-beta.6) (2023-12-12)
-
-
-### Bug Fixes
-
-* fix custom user agent option ([75f5f97](https://github.com/commercelayer/provisioning-sdk/commit/75f5f97e3dade5dd43905deba81f6c4ed46ca21b))
-
-# [1.0.0-beta.5](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.4...v1.0.0-beta.5) (2023-12-07)
-
-
-### Bug Fixes
-
-* singleton import ([9578382](https://github.com/commercelayer/provisioning-sdk/commit/9578382b671629d4891e77f39658ab66828eb357))
-* update schema ([9e569c7](https://github.com/commercelayer/provisioning-sdk/commit/9e569c7484896ea666f5f8079ee0833ed9dc87aa))
-
-# [1.0.0-beta.4](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.3...v1.0.0-beta.4) (2023-11-30)
+* remove axios and support to node <20 ([ab1627d](https://github.com/commercelayer/provisioning-sdk/commit/ab1627d9d7ab79ddedfd1eb4031afc05341a592a))
 
 
 ### Bug Fixes
 
-* release script ([006a747](https://github.com/commercelayer/provisioning-sdk/commit/006a74784c4f2fe302d4d4b0b96673df0067f8a1))
-
-# [1.0.0-beta.3](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.2...v1.0.0-beta.3) (2023-11-30)
+* fix action payload ([832c925](https://github.com/commercelayer/provisioning-sdk/commit/832c92588ebf137f681e2a3a7e4ccd40e202210e))
+* fix fetch response type ([34d5f4a](https://github.com/commercelayer/provisioning-sdk/commit/34d5f4a5910d94983dbf817974b9a5e2dd13018a))
+* fix generator for Nullable type ([fc7507a](https://github.com/commercelayer/provisioning-sdk/commit/fc7507a1fea6e1bd875694cd16005b9d05ff9d6e))
+* fix jsonapi import types ([98a862b](https://github.com/commercelayer/provisioning-sdk/commit/98a862bbd721b724aeb3afa526769ef50a639e7a))
+* fix ListResponse type ([e6e6057](https://github.com/commercelayer/provisioning-sdk/commit/e6e605760f581d70a173ec29e6a7f6bd0bf0481d))
+* fix Nullable type import ([ec89120](https://github.com/commercelayer/provisioning-sdk/commit/ec8912018c7094d8c5900dcd93e39d15702ea6de))
+* fix package exports ([17b6e8b](https://github.com/commercelayer/provisioning-sdk/commit/17b6e8ba2520bc5a50fae69e228680f0c28a5ccc))
+* fix package exports ([a49c437](https://github.com/commercelayer/provisioning-sdk/commit/a49c4379b39c1cd1b02b52375dd76a58371fd0b8))
+* fix plubic resources url ([a768d05](https://github.com/commercelayer/provisioning-sdk/commit/a768d050bc402ef0dc9881d98b4a99d483a5f22e))
+* fix query filters generics ([553bef9](https://github.com/commercelayer/provisioning-sdk/commit/553bef9859c8fa6ce0e185ac825c835ad7e83d2e))
+* fix query generics ([b6d656d](https://github.com/commercelayer/provisioning-sdk/commit/b6d656d155bff7c1b4200ba7dbd9f22d741399bf))
+* fix query params export ([616cda4](https://github.com/commercelayer/provisioning-sdk/commit/616cda43b0937877083a1ae043fee031cf46c870))
+* fix query types ([45c2c50](https://github.com/commercelayer/provisioning-sdk/commit/45c2c5072c7b7cc977a66ab96bee355459c4b95e))
+* fix query types export ([8541850](https://github.com/commercelayer/provisioning-sdk/commit/8541850c4653e07ed50a72819dba678767589228))
+* fix schema parser and source code generator ([1fde5e0](https://github.com/commercelayer/provisioning-sdk/commit/1fde5e0a2284684cbf7d9583701e1eca0c6086c4))
+* fix sortable fields ([493a40b](https://github.com/commercelayer/provisioning-sdk/commit/493a40bcf427e0e21101325a91e4482be6d0d7cb))
+* fix types export ([2f9d2fa](https://github.com/commercelayer/provisioning-sdk/commit/2f9d2fa44419f65e216987d62d32ff3bb4c2836e))
+* update public resources url ([a10cf8e](https://github.com/commercelayer/provisioning-sdk/commit/a10cf8e1346554fe0b00a50be7cc718399d3025c))
 
 
 ### Features
 
-* add custom user agent ([fe2050d](https://github.com/commercelayer/provisioning-sdk/commit/fe2050d4088adbdce4d8e30d6773ebf3fef28e3e))
-
-# [1.0.0-beta.2](https://github.com/commercelayer/provisioning-sdk/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2023-10-31)
-
-
-### Bug Fixes
-
-* **doc:** fix readme ([50bf2b6](https://github.com/commercelayer/provisioning-sdk/commit/50bf2b6debd921e1ca4936ac5acc669b191116ac))
-
-# 1.0.0-beta.1 (2023-10-31)
+* add resource fields examples ([6d17340](https://github.com/commercelayer/provisioning-sdk/commit/6d173404e76a4903edf69ed64df164e367049a65))
+* update resources to schema v1.0.4 ([fbd74ca](https://github.com/commercelayer/provisioning-sdk/commit/fbd74caa90ae05253bf67080baa94c4210bdcd77))
 
 
-### Features
+### BREAKING CHANGES
 
-* first commit of provisioning sdk ([b067f12](https://github.com/commercelayer/provisioning-sdk/commit/b067f123ed9f2e0fce53673306b05fcf479c17f0))
+* remove axios and support to node <20

SECURITY.md

@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 2.x.x   | :white_check_mark: |
 | 1.x.x   | :white_check_mark: |
 | < 1.0.0 | :x:                |
 

gen/fixer.ts

@@ -1,7 +1,9 @@
 /* eslint-disable no-console */
 import { ApiSchema } from './schema'
+import resSchema from './resources.js'
 import { sortObjectFields } from '../src/util'
-import { inspect } from 'util'
+import Inflector from './inflector.js'
+import { CONFIG } from './generator.js'
 
 
 
@@ -30,24 +32,69 @@ const fixRedundantComponents = (schema: ApiSchema): ApiSchema => {
 		res.components = sortObjectFields(res.components)
 
 	})
-	
+
 	console.log('Redundant components have been replaced')
 
 	return schema
 
 }
 
 
-const fixSchema = (schema: ApiSchema): ApiSchema => {
+const fixSchema = async (schema: ApiSchema): Promise<ApiSchema> => {
+
 	console.log('Fixing parsed schema...')
-	const fixedSchema = fixRedundantComponents(schema)
+
+	let fixedSchema = schema
+	fixedSchema = fixRedundantComponents(fixedSchema)
+	fixedSchema = await enrichSchema(fixedSchema)
+
 	console.log('Schema fixed.')
+
 	return fixedSchema
+
 }
 
 
-export default fixSchema
+const enrichSchema = async (schema: ApiSchema): Promise<ApiSchema> => {
+
+	const resourcesInfo = CONFIG.LOCAL? resSchema.load() : await resSchema.download()
+
+	if (!resourcesInfo) {
+		console.log('Error reading reasources data')
+		process.exit()
+	}
+
+	Object.entries(schema.components).forEach(([key, val]) => {
+		const resId = Inflector.snakeCase(key)
+		const resFields = resSchema.getResourceFields(resourcesInfo, resId)
+		if (resFields) Object.entries(val.attributes).forEach(([name, info]) => {
+			const field = resFields[name]
+			if (!field) console.log(`Warning, field not found in resources data: ${resId}.${name}`)
+			info.sortable = field?.sortable || false
+			info.filterable = field?.filterable || false
+		})
+	})
+
+
+	Object.values(schema.resources).forEach(r => {
+		Object.entries(r.components).forEach(([key, val]) => {
+			const resId = Inflector.snakeCase(key)
+			const resFields = resSchema.getResourceFields(resourcesInfo, resId)
+			if (resFields) Object.entries(val.attributes).forEach(([name, info]) => {
+				const field = resFields[name]
+				if (!field) console.log(`Warning, field not found in resources data: ${resId}.${name}`)
+				info.sortable = field?.sortable || false
+				info.filterable = field?.filterable || false
+			})
+		})
+	})
+
 
+	console.log('Api schema has been enriched with resources data')
+
+	return schema
+
+}
 
 
 const fixHeadingEmptyLines = (lines: string[]): string[] => {
@@ -62,4 +109,8 @@ const fixHeadingEmptyLines = (lines: string[]): string[] => {
 }
 
 
-export { fixHeadingEmptyLines }
+
+export default {
+	fixSchema,
+	fixHeadingEmptyLines
+}