apify-schema-tools 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 2.0.2
+
+### Fixed
+
+- Input utils now satisfy TypeScript constraints.
+
+### Removed
+
+- The constant 
+
 ## 2.0.1
 
 ### Added

package/dist/apify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apify.d.ts","sourceRoot":"","sources":["../src/apify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAA+B,MAAM,mBAAmB,CAAC;AAGnF,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AA+CrD,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAQnF;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,YAAY,UAwD3E;AAED,eAAO,MAAM,oBAAoB,WAAW,CAAC"}
+{"version":3,"file":"apify.d.ts","sourceRoot":"","sources":["../src/apify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAA+B,MAAM,mBAAmB,CAAC;AAGnF,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AA+CrD,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAQnF;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,YAAY,UA0E3E;AAED,eAAO,MAAM,oBAAoB,WAAW,CAAC"}

package/dist/apify.js

@@ -75,15 +75,24 @@ export function generateInputDefaultsTSFileContent(inputSchema) {
             requiredParamsWithoutDefaults.push(key);
         }
     }
+    const areThereDefaults = Object.keys(optionalParamsWithDefaults.properties).length > 0;
     return `\
 import { Actor } from "apify";
 import type { Input } from "./input.js";
 
-export const DEFAULT_INPUT_VALUES = ${JSON.stringify(defaultValues, null, "\t")};
+${areThereDefaults
+        ? `\
+interface DefaultInputs ${serializeTypeScriptSchema(optionalParamsWithDefaults)};
 
-export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = ${JSON.stringify(requiredParamsWithoutDefaults, null, "\t")};
+export type InputWithDefaults = Input & DefaultInputs;
+
+export const DEFAULT_INPUT_VALUES: DefaultInputs = ${JSON.stringify(defaultValues, null, "\t")};`
+        : `\
+export type InputWithDefaults = Input;
 
-export type InputWithDefaults = Input & ${serializeTypeScriptSchema(optionalParamsWithDefaults)}
+export const DEFAULT_INPUT_VALUES: Record<string, unknown> = {};`}
+
+export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = ${JSON.stringify(requiredParamsWithoutDefaults, null, "\t")};
 
 export function getInputWithDefaultValues(input?: Input | null): InputWithDefaults {
 	if (Actor.isAtHome()) {
@@ -96,10 +105,14 @@ ${requiredParamsWithoutDefaults.length > 0
 		throw new Error(\`Input is required, because the following fields are required: $\{REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT.join(", ")\}\`);
 	}`
         : ""}
+${areThereDefaults
+        ? `\
 	return {
 		...DEFAULT_INPUT_VALUES,
 		...(input ?? {} as Input),
-	};
+	};`
+        : `\
+	return input ?? {} as Input;`}
 }
 `;
 }

package/dist/apify.js.map

@@ -1 +1 @@
-{"version":3,"file":"apify.js","sourceRoot":"","sources":["../src/apify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAA4B,+BAA+B,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAEvH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AAErD,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG;IACjC,MAAM;IACN,OAAO;IACP,aAAa;IACb,SAAS;IACT,SAAS;IACT,SAAS;IACT,gBAAgB;IAChB,oBAAoB;CACpB,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAEvF,MAAM,iCAAiC,GAA6B;IACnE,MAAM,EAAE;QACP,QAAQ;QACR,SAAS;QACT,WAAW;QACX,WAAW;QACX,MAAM;QACN,YAAY;QACZ,UAAU;QACV,UAAU;QACV,UAAU;QACV,cAAc;KACd;IACD,OAAO,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,UAAU,CAAC;IACnE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC;IAC7D,MAAM,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC;IAC9F,KAAK,EAAE;QACN,QAAQ;QACR,gBAAgB;QAChB,kBAAkB;QAClB,YAAY;QACZ,cAAc;QACd,UAAU;QACV,UAAU;QACV,aAAa;QACb,UAAU;QACV,cAAc;KACd;CACD,CAAC;AAEF,MAAM,UAAU,gCAAgC,CAAC,MAAoB;IACpE,OAAO,2BAA2B,CACjC,MAAM,EACN,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,iCAAiC,CACjC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAAC,WAAyB;IAC3E,MAAM,aAAa,GAA4B,EAAE,CAAC;IAElD,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;QACnF,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;YAC7B,aAAa,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;QAC9C,CAAC;IACF,CAAC;IACD,MAAM,iBAAiB,GAAG,+BAA+B,CAAC,WAAW,CAAC,CAAC;IAEvE,MAAM,0BAA0B,GAAwB;QACvD,OAAO,EAAE,KAAK;QACd,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE,EAAE;KACd,CAAC;IACF,MAAM,6BAA6B,GAAa,EAAE,CAAC;IACnD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1E,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,IAAI,aAAa,EAAE,CAAC;YAChD,0BAA0B,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG;gBAC5C,GAAG,MAAM;gBACT,UAAU,EAAE,IAAI;aAChB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC;YACzD,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;IACF,CAAC;IAED,OAAO;;;;sCAI8B,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC;;uDAExB,IAAI,CAAC,SAAS,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC;;0CAEtE,yBAAyB,CAAC,0BAA0B,CAAC;;;;;;;EAQ9F,6BAA6B,CAAC,MAAM,GAAG,CAAC;QACvC,CAAC,CAAC;;;GAGD;QACD,CAAC,CAAC,EACJ;;;;;;CAMC,CAAC;AACF,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"apify.js","sourceRoot":"","sources":["../src/apify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAA4B,+BAA+B,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAEvH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AAErD,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG;IACjC,MAAM;IACN,OAAO;IACP,aAAa;IACb,SAAS;IACT,SAAS;IACT,SAAS;IACT,gBAAgB;IAChB,oBAAoB;CACpB,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAEvF,MAAM,iCAAiC,GAA6B;IACnE,MAAM,EAAE;QACP,QAAQ;QACR,SAAS;QACT,WAAW;QACX,WAAW;QACX,MAAM;QACN,YAAY;QACZ,UAAU;QACV,UAAU;QACV,UAAU;QACV,cAAc;KACd;IACD,OAAO,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE,UAAU,CAAC;IACnE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC;IAC7D,MAAM,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC;IAC9F,KAAK,EAAE;QACN,QAAQ;QACR,gBAAgB;QAChB,kBAAkB;QAClB,YAAY;QACZ,cAAc;QACd,UAAU;QACV,UAAU;QACV,aAAa;QACb,UAAU;QACV,cAAc;KACd;CACD,CAAC;AAEF,MAAM,UAAU,gCAAgC,CAAC,MAAoB;IACpE,OAAO,2BAA2B,CACjC,MAAM,EACN,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,iCAAiC,CACjC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAAC,WAAyB;IAC3E,MAAM,aAAa,GAA4B,EAAE,CAAC;IAElD,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;QACnF,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;YAC7B,aAAa,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;QAC9C,CAAC;IACF,CAAC;IACD,MAAM,iBAAiB,GAAG,+BAA+B,CAAC,WAAW,CAAC,CAAC;IAEvE,MAAM,0BAA0B,GAAwB;QACvD,OAAO,EAAE,KAAK;QACd,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE,EAAE;KACd,CAAC;IACF,MAAM,6BAA6B,GAAa,EAAE,CAAC;IACnD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1E,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,IAAI,aAAa,EAAE,CAAC;YAChD,0BAA0B,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG;gBAC5C,GAAG,MAAM;gBACT,UAAU,EAAE,IAAI;aAChB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC;YACzD,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;IACF,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAEvF,OAAO;;;;EAKP,gBAAgB;QACf,CAAC,CAAC;0BACsB,yBAAyB,CAAC,0BAA0B,CAAC;;;;qDAI1B,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG;QAC/F,CAAC,CAAC;;;iEAIJ;;uDAEuD,IAAI,CAAC,SAAS,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC;;;;;;;EAQ/G,6BAA6B,CAAC,MAAM,GAAG,CAAC;QACvC,CAAC,CAAC;;;GAGD;QACD,CAAC,CAAC,EACJ;EAEC,gBAAgB;QACf,CAAC,CAAC;;;;IAIA;QACF,CAAC,CAAC;8BAEJ;;CAEC,CAAC;AACF,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "apify-schema-tools",
-	"version": "2.0.1",
+	"version": "2.0.2",
 	"description": "Apify schema managing tools.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/apify.ts

@@ -90,15 +90,27 @@ export function generateInputDefaultsTSFileContent(inputSchema: ObjectSchema) {
 		}
 	}
 
+	const areThereDefaults = Object.keys(optionalParamsWithDefaults.properties).length > 0;
+
 	return `\
 import { Actor } from "apify";
 import type { Input } from "./input.js";
 
-export const DEFAULT_INPUT_VALUES = ${JSON.stringify(defaultValues, null, "\t")};
+${
+	areThereDefaults
+		? `\
+interface DefaultInputs ${serializeTypeScriptSchema(optionalParamsWithDefaults)};
+
+export type InputWithDefaults = Input & DefaultInputs;
 
-export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = ${JSON.stringify(requiredParamsWithoutDefaults, null, "\t")};
+export const DEFAULT_INPUT_VALUES: DefaultInputs = ${JSON.stringify(defaultValues, null, "\t")};`
+		: `\
+export type InputWithDefaults = Input;
+
+export const DEFAULT_INPUT_VALUES: Record<string, unknown> = {};`
+}
 
-export type InputWithDefaults = Input & ${serializeTypeScriptSchema(optionalParamsWithDefaults)}
+export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = ${JSON.stringify(requiredParamsWithoutDefaults, null, "\t")};
 
 export function getInputWithDefaultValues(input?: Input | null): InputWithDefaults {
 	if (Actor.isAtHome()) {
@@ -113,10 +125,16 @@ ${
 	}`
 		: ""
 }
+${
+	areThereDefaults
+		? `\
 	return {
 		...DEFAULT_INPUT_VALUES,
 		...(input ?? {} as Input),
-	};
+	};`
+		: `\
+	return input ?? {} as Input;`
+}
 }
 `;
 }

package/test/apify.test.ts

@@ -1,9 +1,11 @@
 import { describe, expect, it } from "vitest";
+
+import { generateInputDefaultsTSFileContent } from "../src/apify.js";
 import type { ObjectSchema } from "../src/json-schemas";
 
 describe("Apify utilities", () => {
 	describe("generateInputDefaultsTSFileContent", () => {
-		it("should generate TypeScript content with default values", async () => {
+		it("should generate the correct content with default values", async () => {
 			const inputSchema: ObjectSchema = {
 				type: "object",
 				properties: {
@@ -14,15 +16,73 @@ describe("Apify utilities", () => {
 				required: ["name"],
 			};
 
-			const tsContent = await import("../src/apify.js").then((mod) =>
-				mod.generateInputDefaultsTSFileContent(inputSchema),
+			const tsContent = generateInputDefaultsTSFileContent(inputSchema);
+
+			expect(tsContent).toEqual(
+				`import { Actor } from "apify";
+import type { Input } from "./input.js";
+
+interface DefaultInputs {
+	age: number;
+};
+
+export type InputWithDefaults = Input & DefaultInputs;
+
+export const DEFAULT_INPUT_VALUES: DefaultInputs = {
+	"name": "John Doe",
+	"age": 30
+};
+
+export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = [];
+
+export function getInputWithDefaultValues(input?: Input | null): InputWithDefaults {
+	if (Actor.isAtHome()) {
+		// The platform is supposed to fill in the default values
+		return input as InputWithDefaults;
+	}
+
+	return {
+		...DEFAULT_INPUT_VALUES,
+		...(input ?? {} as Input),
+	};
+}
+`,
 			);
+		});
 
-			expect(tsContent).toContain("export type InputWithDefaults = Input & {");
-			expect(tsContent).toContain("export const DEFAULT_INPUT_VALUES = {");
-			expect(tsContent).toContain('"name": "John Doe"');
-			expect(tsContent).toContain('"age": 30');
-			expect(tsContent).toContain("age: number;");
+		it("should generate the correct content without default values", async () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: { type: "string", default: "John Doe" },
+					age: { type: "number" },
+					email: { type: "string" },
+				},
+				required: ["name"],
+			};
+
+			const tsContent = generateInputDefaultsTSFileContent(inputSchema);
+
+			expect(tsContent).toEqual(
+				`import { Actor } from "apify";
+import type { Input } from "./input.js";
+
+export type InputWithDefaults = Input;
+
+export const DEFAULT_INPUT_VALUES: Record<string, unknown> = {};
+
+export const REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT = [];
+
+export function getInputWithDefaultValues(input?: Input | null): InputWithDefaults {
+	if (Actor.isAtHome()) {
+		// The platform is supposed to fill in the default values
+		return input as InputWithDefaults;
+	}
+
+	return input ?? {} as Input;
+}
+`,
+			);
 		});
 	});
 });