apify-schema-tools 2.0.1

package/.cspell/custom-dictionary.txt

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

package/.husky/pre-commit

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+set -e
+
+echo "Checking linting and formatting..."
+
+npm run check
+
+# Check some samples' consistency
+
+echo "Checking samples..."
+
+EXEC_PATH="$(pwd)/dist/apify-schema-tools.js"
+
+cd samples/all-defaults
+node $EXEC_PATH check
+cd ../..
+
+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/.node-version

@@ -0,0 +1 @@
+v23

package/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+## 2.0.1
+
+### Added
+
+- Repository information in package.json.
+
+### Fixed
+
+- README code blocks.
+
+## 2.0.0
+
+### BREAKING CHANGES
+
+- The script `apify-generate` has been removed.
+- The script `generate-apify-schema` has been removed.
+- The script `generate-apify-type` has been removed.
+
+### Added
+
+- The script `apify-schema-tools` has been added.
+- The subcommand `init` allows to setup `apify-schema-tools` in a project.
+- The subcommand `sync` perform the synchronization of the source schemas, like the former command `apify-generate`
+- The subcommand `check` checks for consistency between the source and the generated files.
+- Allow checking only the values, ignoring descriptions.
+- Options can be set in `package.json`, under the property `apify-schema-tools`. CLI parameters will override the options.
+- Support enums in JSON schemas.
+- Support nullable properties in JSON schemas.
+- Change `integer` into `number` when creating TypeScript types.
+
+### Technical changes
+
+- Implemented a custom TypeScript serializer and parser, to better support checking TypeScript interfaces.
+
+## 1.3.0
+
+### Added
+
+- The option `--deep-merge` allows to keep object and array definitions from both the base and the additional schemas.
+
+### Fixed
+
+- The generated `input-utils.ts` file now avoids TypeScript errors in some occasions.
+
+## 1.2.0
+
+### Added
+
+- The `--add-input` and `--add-dataset` options allow to merge a second input or dataset schema into the source one.
+
+## 1.1.1
+
+### Fixed
+
+- The generated `getInputWithDefaultValues` also assumes that the input can be null.
+
+## 1.1.0
+
+### Added
+
+- `DEFAULT_INPUT_VALUES` and `REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT` are exported by `input-utils.ts`.
+
+### Fixed
+
+- The generated `input-utils.ts` is more friendly with formatters.
+
+### Changed
+
+- The example input in the README's quickstart was simplified.
+
+## 1.0.0
+
+### Added
+
+- Script `apify-generate` to generate both JSON schema and TypeScript files.
+- Unit and integration tests.
+- Pre-commit hook that run the tests.
+- Some samples to test the script.
+
+### Changed
+
+- The README now documents only the new command `apify-generate`.
+
+### Deprecated
+
+- Scripts `generate-apify-schemas` and `generate-apify-types`.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,312 @@
+# Apify Schema Tools
+
+This is a tool intended for Apify actors developers.
+
+It allows generating JSON schemas and TypeScript types, for input and dataset,
+from a single source of truth, with a few extra features.
+
+As a quick example, assume you have a project that looks like this:
+
+```
+my-project
+├── .actor
+│   ├── actor.json
+│   ├── dataset_schema.json
+│   └── input_schema.json
+└── src-schemas
+    ├── dataset-item.json <-- source file for dataset
+    └── input.json        <-- source file for input
+```
+
+After running this script, you will have:
+
+```
+my-project
+├── .actor
+│   ├── actor.json
+│   ├── dataset_schema.json <-- updated with the definitions from src-schemas
+│   └── input_schema.json   <-- updated with the definitions from src-schemas
+├── src
+│   └── generated
+│       ├── dataset.ts     <-- TypeScript types generated from src-schemas
+│       ├── input-utils.ts <-- utilities to fill input default values
+│       └── input.ts       <-- TypeScript types generated from src-schemas
+└── src-schemas
+    ├── dataset-item.json
+    └── input.json
+```
+
+## Quickstart
+
+These instructions will allow you to quickly get to a point where you can use
+the `apify-schema-tools` to generate your schemas and TypeScript types.
+
+Let's assume you are starting from a new project created from an
+[Apify template](https://github.com/apify/actor-templates).
+
+1. Install `apify-schema-tools`:
+
+```sh
+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:
+
+```console
+$ npx apify-schema-tools --help
+usage: apify-schema-tools [-h] {init,sync,check} ...
+
+Apify Schema Tools - Generate JSON schemas and TypeScript files for Actor input and output dataset.
+
+positional arguments:
+  {init,sync,check}
+    init             Initialize the Apify Schema Tools project with default settings.
+    sync             Generate JSON schemas and TypeScript files from the source schemas.
+    check            Check the schemas for consistency and correctness.
+
+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]
+                               [--deep-merge] [--include-input-utils {true,false}]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i [{input,dataset} ...], --input [{input,dataset} ...]
+                        specify which sources to use for generation (default: input,dataset)
+  -o [{json-schemas,ts-types} ...], --output [{json-schemas,ts-types} ...]
+                        specify what to generate (default: json-schemas,ts-types)
+  --src-input SRC_INPUT
+                        path to the input schema source file (default: src-schemas/input.json)
+  --src-dataset SRC_DATASET
+                        path to the dataset schema source file (default: src-schemas/dataset-item.json)
+  --add-input ADD_INPUT
+                        path to an additional schema to merge into the input schema (default: undefined)
+  --add-dataset ADD_DATASET
+                        path to an additional schema to merge into the dataset schema (default: undefined)
+  --input-schema INPUT_SCHEMA
+                        the path of the destination input schema file (default: .actor/input_schema.json)
+  --dataset-schema DATASET_SCHEMA
+                        the path of the destination dataset schema file (default: .actor/dataset_schema.json)
+  --output-ts-dir OUTPUT_TS_DIR
+                        path where to save generated TypeScript files (default: src/generated)
+  --deep-merge          whether to deep merge additional schemas into the main schema (default: false)
+  --include-input-utils {true,false}
+                        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.
+
+2. 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:
+
+```json
+{
+  "title": "Input schema for Web Scraper",
+  "type": "object",
+  "schemaVersion": 1,
+  "properties": {
+    "startUrls": {
+      "type": "array",
+      "title": "Start URLs",
+      "description": "List of URLs to scrape",
+      "default": [],
+      "editor": "requestListSources",
+      "items": {
+        "type": "object",
+        "properties": {
+          "url": { "type": "string" }
+        }
+      }
+    }
+  },
+  "required": ["startUrls"]
+}
+```
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Dataset schema for Web Scraper",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "title": "Title",
+      "description": "Page title"
+    },
+    "url": {
+      "type": "string",
+      "title": "URL",
+      "description": "Page URL"
+    },
+    "text": {
+      "type": "string",
+      "title": "Text content",
+      "description": "Extracted text"
+    },
+    "timestamp": {
+      "type": "string",
+      "title": "Timestamp",
+      "description": "When the data was scraped"
+    }
+  },
+  "required": ["title", "url"]
+}
+```
+
+4. Create the file `.actor/dataset_schema.json` and enter some empty content:
+
+```json
+{
+    "actorSpecification": 1,
+    "fields": {},
+    "views": {}
+}
+```
+
+5. Link the dataset schema in `.actor/actor.json`:
+
+```json
+{
+    "actorSpecification": 1,
+    "...": "...",
+    "input": "./input_schema.json",
+    "storages": {
+        "dataset": "./dataset_schema.json"
+    },
+    "...": "..."
+}
+```
+
+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:
+
+```sh
+npm run generate
+```
+
+8. 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();
+```
+
+## Extra features
+
+### Keep only allowed properties in Input schema
+
+As an example, when `type` is "array", the property `items` is forbidden if `editor` is different from "select".
+
+### Merge a second schema into the main one
+
+This feature is useful when working in monorepos.
+It allows you to define a single common schema across all the actors in the repo,
+and to add or override the tile, the description, and some properties, when necessary.
+
+To use it, use the parameters `--add-input` and `--add-dataset`, e.g.:
+
+```sh
+npx apify-schema-tools sync \
+  --input input,dataset \
+  --output json-schemas,ts-types \
+  --src-input ../src-schemas/input.json \
+  --src-dataset ../src-schemas/dataset-item.json \
+  --add-input src-schemas/input.json \
+  --add-dataset src-schemas/dataset-item.json
+```
+
+You can also define the order of the properties in the merged schema.
+To do so, add a `position` field to the properties. The script will follow these rules:
+
+- Properties without position or with the same position, are sorted in the same order in which they appear in the source
+  schemas, with the ones in the additional schema after the ones in the base schema.
+- If both properties with and without position exist, the ones without position will appear at the end.
+- The position will be overwritten if a property is overwritten.
+
+An example:
+
+```jsonc
+# Source input schema
+{
+  "title": "My input schema",
+  "description": "My input properties",
+  "properties": {
+    "a": { "type": "string", "position": 3 },
+    "b": { "type": "string" }, // will be last, because it has no position
+    "c": { "type": "string", "position": 1 }
+  },
+  "required": ["a"]
+}
+```
+
+```jsonc
+# Additional input schema
+{
+  "description": "My input properties, a bit changed", // will override the description
+  "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
+}
+```
+
+```jsonc
+# Final input schema
+{
+  "title": "My input schema",
+  "description": "My input properties, a bit changed",
+  "properties": {
+    "d": { "type": "string" },
+    "a": { "type": "string" },
+    "c": { "type": "boolean" },
+    "b": { "type": "string" }
+  },
+  "required": ["a", "c", "d"]
+}
+```
+
+Use the option `--deep-merge` to merge object properties and array items, instead of overwriting every definition.

package/biome.json

@@ -0,0 +1,31 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"files": {
+		"ignoreUnknown": false,
+		"ignore": []
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab",
+		"lineWidth": 120
+	},
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	}
+}

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

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=apify-schema-tools.d.ts.map

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

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