apify-schema-tools 2.0.4 → 2.1.0

package/.cspell/custom-dictionary.txt

@@ -1,4 +1,5 @@
 # Custom Dictionary Words
 apify
+Filenaming
 nargs
 subparsers

package/.husky/pre-commit

@@ -20,14 +20,6 @@ cd samples/package-json-config
 node $EXEC_PATH check
 cd ../..
 
-echo "Checking for .only() in test files..."
-
-# Check for .only( in test files
-if grep -r "\.only(" --include="*.test.ts" .; then
-  echo "Error: found \".only(\" in test files. Please remove focused tests before committing."
-  exit 1
-fi
-
 echo "Running tests..."
 
 npm test

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 2.1.0
+
+### Added
+
+- Support for JSON schema's `additionalProperties` field.
+- `additionalProperties` is set to true by default.
+
+### Changed
+
+- The `init` command will not override existing source schemas anymore.
+
+### Documentation
+
+- The new features of v2 are now documented in the README file.
+
+## 2.0.5
+
+### Fixed
+
+- Fix linting in generated TypeScript code with some ESLint rules.
+
 ## 2.0.4
 
 ### Fixed

package/README.md

@@ -50,8 +50,75 @@ Let's assume you are starting from a new project created from an
 npm i -D apify-schema-tools
 ```
 
-Now the command `apify-schema-tools` is installed for the current project.
-You can check which options are available:
+2. Initialize your project with default settings:
+
+```sh
+npx apify-schema-tools init
+```
+
+This command will:
+- Create a `src-schemas` folder with `input.json` and `dataset-item.json` files.
+- Create the necessary `.actor` files if they don't exist.
+- Add configuration to your `package.json`.
+- Add a `generate` script to your `package.json`.
+
+3. Generate JSON schemas and TypeScript types from the source schemas:
+
+```sh
+npm apify-schema-tools sync
+```
+
+4. Now, you will be able to use TypeScript types and utilities in your project:
+
+```ts
+import { Actor } from 'apify';
+
+import type { DatasetItem } from './generated/dataset.ts';
+import type { Input } from './generated/input.ts';
+import { getInputWithDefaultValues, type InputWithDefaults } from './generated/input-utils.ts';
+
+await Actor.init();
+
+const input: InputWithDefaults = getInputWithDefaultValues(await Actor.getInput<Input>());
+
+'...'
+
+await Actor.pushData<DatasetItem>({
+    tile: '...',
+    url: '...',
+    text: '...',
+    timestamp: '...',
+});
+
+await Actor.exit();
+```
+
+## Configuration
+
+You can configure `apify-schema-tools` in two ways:
+
+### Using package.json configuration
+
+The `init` command automatically adds configuration to your `package.json`. You can also manually add an `apify-schema-tools` section to customize the behavior:
+
+```json
+{
+  "name": "my-actor",
+  "version": "1.0.0",
+  "apify-schema-tools": {
+    "input": ["input", "dataset"],
+    "output": ["json-schemas", "ts-types"],
+    "srcInput": "src-schemas/input.json",
+    "srcDataset": "src-schemas/dataset-item.json",
+    "outputTSDir": "src/generated",
+    "includeInputUtils": true
+  }
+}
+```
+
+### Using command-line arguments
+
+You can also pass options directly to the `sync` command. You can check which options are available:
 
 ```console
 $ npx apify-schema-tools --help
@@ -69,8 +136,6 @@ optional arguments:
   -h, --help         show this help message and exit
 ```
 
-You can also check the options available for a specific command:
-
 ```console
 $ npx apify-schema-tools sync --help
 usage: apify-schema-tools sync [-h] [-i [{input,dataset} ...]] [-o [{json-schemas,ts-types} ...]] [--src-input SRC_INPUT] [--src-dataset SRC_DATASET] [--add-input ADD_INPUT] [--add-dataset ADD_DATASET] [--input-schema INPUT_SCHEMA] [--dataset-schema DATASET_SCHEMA] [--output-ts-dir OUTPUT_TS_DIR]
@@ -101,16 +166,17 @@ optional arguments:
                         include input utilities in the generated TypeScript files: 'input' input and 'ts-types' output are required (default: true)
 ```
 
-You can customize the path of all the files involved in the generation.
-In this case, we will use the default locations, so the commands will be simpler.
+## Setting up your project manually
 
-2. Create a `src-schemas` folder:
+If you prefer to set up your project manually instead of using the `init` command, you can follow these steps:
+
+1. Create a `src-schemas` folder:
 
 ```sh
 mkdir src-schemas
 ```
 
-3. Create the files `input.json` and `dataset-item.json` inside the `src-schemas`. Here is some example content:
+2. Create the files `input.json` and `dataset-item.json` inside the `src-schemas`. Here is some example content:
 
 ```json
 {
@@ -132,7 +198,8 @@ mkdir src-schemas
       }
     }
   },
-  "required": ["startUrls"]
+  "required": ["startUrls"],
+  "additionalProperties": false
 }
 ```
 
@@ -167,7 +234,7 @@ mkdir src-schemas
 }
 ```
 
-4. Create the file `.actor/dataset_schema.json` and enter some empty content:
+3. Create the file `.actor/dataset_schema.json` and enter some empty content:
 
 ```json
 {
@@ -177,7 +244,7 @@ mkdir src-schemas
 }
 ```
 
-5. Link the dataset schema in `.actor/actor.json`:
+4. Link the dataset schema in `.actor/actor.json`:
 
 ```json
 {
@@ -191,49 +258,40 @@ mkdir src-schemas
 }
 ```
 
-6. Add the script to `package.json`:
-
-```json
-{
-    "...": "...",
-    "scripts": {
-        "...": "...",
-        "generate": "apify-schema-tools sync"
-    }
-}
-```
 
-7. Generate JSON schemas and TypeScript types from the source schemas:
+5. Generate JSON schemas and TypeScript types from the source schemas:
 
 ```sh
-npm run generate
+npm apify-schema-tools sync
 ```
 
-8. Now, you will be able to use TypeScript types and utilities in your project:
-
-```ts
-import { Actor } from 'apify';
+## Checking if the schemas are in sync with the source schemas
 
-import type { DatasetItem } from './generated/dataset.ts';
-import type { Input } from './generated/input.ts';
-import { getInputWithDefaultValues, type InputWithDefaults } from './generated/input-utils.ts';
+The `check` command allows you to verify that your generated schemas and TypeScript files are up-to-date with your source schemas. This is particularly useful in CI/CD pipelines to ensure that developers haven't forgotten to run the generation after making changes to the source schemas.
 
-await Actor.init();
+```sh
+npx apify-schema-tools check
+```
 
-const input: InputWithDefaults = getInputWithDefaultValues(await Actor.getInput<Input>());
+The `check` command will:
+- Compare the current generated files with what would be generated from the source schemas
+- Exit with code 0 if everything is in sync
+- Exit with code 1 if there are differences, showing you which files are out of sync
 
-'...'
+You can add this to your CI pipeline to automatically detect when schemas need to be regenerated:
 
-await Actor.pushData<DatasetItem>({
-    tile: '...',
-    url: '...',
-    text: '...',
-    timestamp: '...',
-});
-
-await Actor.exit();
+```json
+{
+  "scripts": {
+    "generate": "apify-schema-tools sync",
+    "check-schemas": "apify-schema-tools check",
+    "test": "npm run check-schemas && npm run test:unit"
+  }
+}
 ```
 
+The `check` command accepts the same configuration options as the `sync` command, either through `package.json` configuration or command-line arguments, ensuring it checks the same files that would be generated.
+
 ## Extra features
 
 ### Keep only allowed properties in Input schema
@@ -273,12 +331,14 @@ An example:
 {
   "title": "My input schema",
   "description": "My input properties",
+  "type": "object",
   "properties": {
     "a": { "type": "string", "position": 3 },
     "b": { "type": "string" }, // will be last, because it has no position
     "c": { "type": "string", "position": 1 }
   },
-  "required": ["a"]
+  "required": ["a"],
+  "additionalProperties": false
 }
 ```
 
@@ -286,11 +346,13 @@ An example:
 # Additional input schema
 {
   "description": "My input properties, a bit changed", // will override the description
+  "type": "object",
   "properties": {
     "c": { "type": "boolean", "position": 5 }, // will override also the position
     "d": { "type": "string", "position": 1 } // will be first
   },
-  "required": ["c", "d"] // will be merged to the source required parameters
+  "required": ["c", "d"], // will be merged to the source required parameters
+  "additionalProperties": false
 }
 ```
 
@@ -299,13 +361,15 @@ An example:
 {
   "title": "My input schema",
   "description": "My input properties, a bit changed",
+  "type": "object",
   "properties": {
     "d": { "type": "string" },
     "a": { "type": "string" },
     "c": { "type": "boolean" },
     "b": { "type": "string" }
   },
-  "required": ["a", "c", "d"]
+  "required": ["a", "c", "d"],
+  "additionalProperties": false
 }
 ```
 

package/biome.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+	"$schema": "https://biomejs.dev/schemas/2.1.0/schema.json",
 	"vcs": {
 		"enabled": true,
 		"clientKind": "git",
@@ -7,25 +7,137 @@
 	},
 	"files": {
 		"ignoreUnknown": false,
-		"ignore": []
+		"includes": ["**"]
 	},
 	"formatter": {
 		"enabled": true,
 		"indentStyle": "tab",
 		"lineWidth": 120
 	},
-	"organizeImports": {
-		"enabled": true
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
 	},
+	"assist": { "actions": { "source": { "organizeImports": "on" } } },
 	"linter": {
 		"enabled": true,
+		"domains": {
+			"test": "all",
+			"project": "all"
+		},
 		"rules": {
-			"recommended": true
+			"recommended": true,
+			"complexity": {
+				"noExcessiveCognitiveComplexity": "on",
+				"noExcessiveNestedTestSuites": "on",
+				"noForEach": "on",
+				"noUselessStringConcat": "on",
+				"noVoid": "on",
+				"useSimplifiedLogicExpression": "on",
+				"useWhile": "on"
+			},
+			"correctness": {
+				"noPrivateImports": "on",
+				"noUndeclaredDependencies": "on",
+				"noUndeclaredVariables": "on"
+			},
+			"nursery": {
+				"noAwaitInLoop": "on",
+				"noBitwiseOperators": "on",
+				"noConstantBinaryExpression": "on",
+				"noExcessiveLinesPerFunction": "on",
+				"noImportCycles": "on",
+				"noMagicNumbers": "on",
+				"noShadow": "on",
+				"noUnassignedVariables": "on",
+				"noUselessBackrefInRegex": "on",
+				"useAdjacentGetterSetter": "on",
+				"useIterableCallbackReturn": "on",
+				"useJsonImportAttribute": "on",
+				"useNumericSeparators": "on",
+				"useObjectSpread": "on"
+			},
+			"performance": {
+				"noBarrelFile": "on",
+				"noDelete": "on",
+				"noNamespaceImport": "on",
+				"noReExportAll": "on",
+				"useTopLevelRegex": "on"
+			},
+			"style": {
+				"noCommonJs": "on",
+				"noDefaultExport": "on",
+				"noDoneCallback": "on",
+				"noEnum": "on",
+				"noExportedImports": "on",
+				"noInferrableTypes": "on",
+				"noNamespace": "on",
+				"noNegationElse": "on",
+				"noNestedTernary": "on",
+				"noParameterAssign": "on",
+				"noParameterProperties": "on",
+				"noProcessEnv": "on",
+				"noUnusedTemplateLiteral": "on",
+				"noUselessElse": "on",
+				"noYodaExpression": "on",
+				"useAsConstAssertion": "on",
+				"useAtIndex": "on",
+				"useBlockStatements": "on",
+				"useCollapsedElseIf": "on",
+				"useCollapsedIf": "on",
+				"useConsistentArrayType": "on",
+				"useConsistentBuiltinInstantiation": "on",
+				"useConsistentMemberAccessibility": "on",
+				"useDefaultParameterLast": "on",
+				"useDefaultSwitchClause": "on",
+				"useExplicitLengthCheck": "on",
+				"useFilenamingConvention": "on",
+				"useForOf": "on",
+				"useNamingConvention": "on",
+				"useNodeAssertStrict": "on",
+				"useNumberNamespace": "on",
+				"useShorthandAssign": "on",
+				"useSingleVarDeclarator": "on",
+				"useThrowNewError": "on",
+				"useThrowOnlyError": "on",
+				"useTrimStartEnd": "on"
+			},
+			"suspicious": {
+				"noDuplicateTestHooks": "on",
+				"noEmptyBlockStatements": "on",
+				"noEvolvingTypes": "on",
+				"noExportsInTest": "on",
+				"noFocusedTests": "on",
+				"noMisplacedAssertion": "on",
+				"useNumberToFixedDigitsArgument": "on"
+			}
 		}
 	},
-	"javascript": {
-		"formatter": {
-			"quoteStyle": "double"
+	"overrides": [
+		{
+			"includes": ["test/**"],
+			"linter": {
+				"rules": {
+					"nursery": {
+						"noExcessiveLinesPerFunction": "off",
+						"noMagicNumbers": "off"
+					},
+					"style": {
+						"useNamingConvention": "off"
+					}
+				}
+			}
+		},
+		{
+			"includes": ["samples/**"],
+			"linter": {
+				"rules": {
+					"correctness": {
+						"noUndeclaredDependencies": "off"
+					}
+				}
+			}
 		}
-	}
+	]
 }

package/dist/apify-schema-tools.d.ts

@@ -1,3 +1,4 @@
 #!/usr/bin/env node
+/** biome-ignore-all lint/style/useNamingConvention: the package `argparse` uses snake_case names */
 export {};
 //# sourceMappingURL=apify-schema-tools.d.ts.map

package/dist/apify-schema-tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apify-schema-tools.d.ts","sourceRoot":"","sources":["../src/apify-schema-tools.ts"],"names":[],"mappings":""}
+{"version":3,"file":"apify-schema-tools.d.ts","sourceRoot":"","sources":["../src/apify-schema-tools.ts"],"names":[],"mappings":";AAEA,oGAAoG"}