zapier-platform-core 18.0.0 → 18.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "18.0.0",
+  "version": "18.0.5",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -24,28 +24,6 @@
     "/src/",
     "/types/"
   ],
-  "scripts": {
-    "preversion": "git pull && yarn test",
-    "version": "node bin/bump-dependencies.js && yarn && git add package.json yarn.lock",
-    "postversion": "git push && git push --tags",
-    "main-tests": "mocha -t 20s --recursive test --exit",
-    "type-tests": "tsd --files types/**/*.test-d.ts",
-    "solo-test": "test $(OPT_OUT_PATCH_TEST_ONLY=yes mocha --recursive test -g 'should be able to opt out of patch' -R json | jq '.stats.passes') -eq 1 && echo 'Ran 1 test and it passed!'",
-    "test": "yarn main-tests && yarn solo-test && yarn type-tests",
-    "test:debug": "mocha inspect -t 10s --recursive test",
-    "debug": "mocha -t 10s --inspect-brk --recursive test",
-    "test:w": "mocha -t 10s --recursive test --watch",
-    "integration-test": "mocha -t 20s integration-test",
-    "local-integration-test": "mocha -t 10s integration-test --local",
-    "lambda-integration-test": "mocha -t 10s integration-test --lambda",
-    "smoke-test": "mocha -t 2m smoke-test",
-    "lint": "eslint src test",
-    "lint:fix": "eslint --fix src test",
-    "build-integration-test": "bin/build.sh local.bundle.zip",
-    "upload-integration-test": "bin/upload-lambda.js local.bundle.zip",
-    "deploy-integration-test": "yarn build-integration-test && yarn upload-integration-test",
-    "validate": "yarn test && yarn smoke-test && yarn lint"
-  },
   "engines": {
     "node": ">=16",
     "npm": ">=5.6.0"
@@ -63,7 +41,7 @@
     "node-fetch": "2.7.0",
     "oauth-sign": "0.9.0",
     "semver": "7.7.2",
-    "zapier-platform-schema": "18.0.0"
+    "zapier-platform-schema": "18.0.5"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",
@@ -77,5 +55,27 @@
   },
   "optionalDependencies": {
     "@types/node": "^20.3.1"
+  },
+  "scripts": {
+    "preversion": "git pull && pnpm test",
+    "version": "node bin/bump-dependencies.js && pnpm install && git add package.json pnpm-lock.yaml",
+    "postversion": "git push && git push --tags",
+    "main-tests": "mocha -t 20s --recursive test --exit",
+    "type-tests": "tsd --files types/**/*.test-d.ts",
+    "solo-test": "test $(OPT_OUT_PATCH_TEST_ONLY=yes mocha --recursive test -g 'should be able to opt out of patch' -R json | jq '.stats.passes') -eq 1 && echo 'Ran 1 test and it passed!'",
+    "test": "pnpm main-tests && pnpm solo-test && pnpm type-tests",
+    "test:debug": "mocha inspect -t 10s --recursive test",
+    "debug": "mocha -t 10s --inspect-brk --recursive test",
+    "test:w": "mocha -t 10s --recursive test --watch",
+    "integration-test": "mocha -t 20s integration-test",
+    "local-integration-test": "mocha -t 10s integration-test --local",
+    "lambda-integration-test": "mocha -t 10s integration-test --lambda",
+    "smoke-test": "mocha -t 2m smoke-test",
+    "lint": "eslint src test",
+    "lint:fix": "eslint --fix src test",
+    "build-integration-test": "bin/build.sh local.bundle.zip",
+    "upload-integration-test": "bin/upload-lambda.js local.bundle.zip",
+    "deploy-integration-test": "pnpm build-integration-test && pnpm upload-integration-test",
+    "validate": "pnpm test && pnpm smoke-test && pnpm lint"
   }
-}
+}

package/types/inputs.d.ts

@@ -241,7 +241,19 @@ export type PlainFieldContribution<$Field extends PlainInputField> =
  */
 type ParentFieldContribution<
   $Field extends PlainInputField & { children: PlainInputField[] },
-> = PlainFieldArrayContribution<$Field['children']>;
+> = Simplify<
+  PlainFieldArrayContribution<$Field['children']> &
+    // When line items are mapped into any child input, then the parent will also
+    // be included as an array of objects containing the children's inputs'
+    // contributions. This may or may not apply on a per-zap basis, so this parent
+    // array is an optional member of inputData.
+    Partial<
+      Record<
+        $Field['key'],
+        Array<PlainFieldArrayContribution<$Field['children']>>
+      >
+    >
+>;
 
 /**
  * Extract the contribution of a dictionary field to the input data. A

package/types/inputs.plainfields.test-d.ts

@@ -14,7 +14,17 @@ type singleRequiredChildren = PlainFieldContribution<{
   key: 'parent_input';
   children: [{ key: 'string_required'; type: 'string'; required: true }];
 }>;
-expectType<singleRequiredChildren>(singleRequiredChild);
+expectAssignable<singleRequiredChildren>(singleRequiredChild);
+expectAssignable<singleRequiredChildren>({
+  string_required: 'some_string',
+  parent_input: [{ string_required: 'value1' }, { string_required: 'value2' }],
+});
+expectType<singleRequiredChildren>(
+  singleRequiredChild as {
+    string_required: string;
+    parent_input?: { string_required: string }[];
+  },
+);
 
 // Complete `children: [{...}]` case.
 const multipleRequiredChild = {
@@ -26,6 +36,26 @@ const multipleRequiredChild = {
   password_required: 'some_password',
   code_required: 'some_code',
 };
+const multipleRequiredChildWithLineItems = {
+  string_required: 'some_string',
+  number_required: 1,
+  boolean_required: true,
+  datetime_required: '2021-01-01T00:00:00Z',
+  file_required: 'some_file',
+  password_required: 'some_password',
+  code_required: 'some_code',
+  parent_input: [
+    {
+      string_required: 'item1',
+      number_required: 2,
+      boolean_required: false,
+      datetime_required: '2022-01-01T00:00:00Z',
+      file_required: 'file1',
+      password_required: 'pass1',
+      code_required: 'code1',
+    },
+  ],
+};
 type multipleRequiredChildren = PlainFieldContribution<{
   key: 'parent_input';
   children: [
@@ -38,10 +68,31 @@ type multipleRequiredChildren = PlainFieldContribution<{
     { key: 'code_required'; type: 'code'; required: true },
   ];
 }>;
-expectType<multipleRequiredChildren>(multipleRequiredChild);
+expectAssignable<multipleRequiredChildren>(multipleRequiredChild);
+expectAssignable<multipleRequiredChildren>(multipleRequiredChildWithLineItems);
+expectType<multipleRequiredChildren>(
+  {} as {
+    string_required: string;
+    number_required: number;
+    boolean_required: boolean;
+    datetime_required: string;
+    file_required: string;
+    password_required: string;
+    code_required: string;
+    parent_input?: {
+      string_required: string;
+      number_required: number;
+      boolean_required: boolean;
+      datetime_required: string;
+      file_required: string;
+      password_required: string;
+      code_required: string;
+    }[];
+  },
+);
 
 // Complete `children: [{...}]` case where all children are optional.
-const multipleOptionalChild = {
+const multipleOptionalChildNoLineItems = {
   string_optional: 'some_string',
   number_optional: 1,
   boolean_optional: true,
@@ -50,6 +101,16 @@ const multipleOptionalChild = {
   password_optional: 'some_password',
   code_optional: 'some_code',
 };
+const multipleOptionalChildWithLineItems = {
+  string_optional: 'some_string',
+  number_optional: 1,
+  boolean_optional: true,
+  datetime_optional: '2021-01-01T00:00:00Z',
+  file_optional: 'some_file',
+  password_optional: 'some_password',
+  code_optional: 'some_code',
+  parent_input: [{ string_optional: 'item1' }],
+};
 type multipleOptionalChildren = PlainFieldContribution<{
   key: 'parent_input';
   children: [
@@ -62,12 +123,50 @@ type multipleOptionalChildren = PlainFieldContribution<{
     { key: 'code_optional'; type: 'code'; required: false },
   ];
 }>;
-expectAssignable<multipleOptionalChildren>(multipleOptionalChild);
 expectAssignable<multipleOptionalChildren>({});
+expectAssignable<multipleOptionalChildren>(multipleOptionalChildNoLineItems);
+expectAssignable<multipleOptionalChildren>({ parent_input: [{}] });
+expectAssignable<multipleOptionalChildren>(multipleOptionalChildWithLineItems);
+expectType<multipleOptionalChildren>(
+  {} as {
+    string_optional?: string;
+    number_optional?: number;
+    boolean_optional?: boolean;
+    datetime_optional?: string;
+    file_optional?: string;
+    password_optional?: string;
+    code_optional?: string;
+    parent_input?: {
+      string_optional?: string;
+      number_optional?: number;
+      boolean_optional?: boolean;
+      datetime_optional?: string;
+      file_optional?: string;
+      password_optional?: string;
+      code_optional?: string;
+    }[];
+  },
+);
 
 // Complete `children: [{...}]` case with complete mixture of required
 // and optional fields.
-const mixedOptionalChildren = {
+const mixedOptionalChildrenNoLineItems = {
+  string_required: 'some_string',
+  string_optional: 'some_string',
+  number_required: 1,
+  number_optional: 1,
+  boolean_required: true,
+  boolean_optional: true,
+  datetime_required: '2021-01-01T00:00:00Z',
+  datetime_optional: '2021-01-01T00:00:00Z',
+  file_required: 'some_file',
+  file_optional: 'some_file',
+  password_required: 'some_password',
+  password_optional: 'some_password',
+  code_required: 'some_code',
+  code_optional: 'some_code',
+};
+const mixedOptionalChildrenWithLineItems = {
   string_required: 'some_string',
   string_optional: 'some_string',
   number_required: 1,
@@ -80,20 +179,75 @@ const mixedOptionalChildren = {
   file_optional: 'some_file',
   password_required: 'some_password',
   password_optional: 'some_password',
+  code_required: 'some_code',
   code_optional: 'some_code',
+  parent_input: [
+    {
+      string_required: 'item1',
+      number_required: 2,
+      boolean_required: false,
+      datetime_required: '2022-01-01T00:00:00Z',
+      file_required: 'file1',
+      password_required: 'pass1',
+      code_required: 'code1',
+    },
+  ],
 };
-type mixedOptionalChildren = PlainFieldContribution<{
+type MixedOptionalChildren = PlainFieldContribution<{
   key: 'parent_input';
   children: [
     { key: 'string_required'; type: 'string'; required: true },
     { key: 'string_optional'; type: 'string'; required: false },
+    { key: 'number_required'; type: 'number'; required: true },
+    { key: 'number_optional'; type: 'number'; required: false },
+    { key: 'boolean_required'; type: 'boolean'; required: true },
+    { key: 'boolean_optional'; type: 'boolean'; required: false },
+    { key: 'datetime_required'; type: 'datetime'; required: true },
+    { key: 'datetime_optional'; type: 'datetime'; required: false },
+    { key: 'file_required'; type: 'file'; required: true },
+    { key: 'file_optional'; type: 'file'; required: false },
+    { key: 'password_required'; type: 'password'; required: true },
+    { key: 'password_optional'; type: 'password'; required: false },
+    { key: 'code_required'; type: 'code'; required: true },
+    { key: 'code_optional'; type: 'code'; required: false },
   ];
 }>;
-expectAssignable<mixedOptionalChildren>(multipleRequiredChild);
-expectAssignable<mixedOptionalChildren>({
-  ...multipleRequiredChild,
-  ...multipleOptionalChild,
-});
+expectAssignable<MixedOptionalChildren>(mixedOptionalChildrenNoLineItems);
+expectAssignable<MixedOptionalChildren>(mixedOptionalChildrenWithLineItems);
+expectType<MixedOptionalChildren>(
+  {} as {
+    string_required: string;
+    string_optional?: string;
+    number_required: number;
+    number_optional?: number;
+    boolean_required: boolean;
+    boolean_optional?: boolean;
+    datetime_required: string;
+    datetime_optional?: string;
+    file_required: string;
+    file_optional?: string;
+    password_required: string;
+    password_optional?: string;
+    code_required: string;
+    code_optional?: string;
+    parent_input?: {
+      string_required: string;
+      string_optional?: string;
+      number_required: number;
+      number_optional?: number;
+      boolean_required: boolean;
+      boolean_optional?: boolean;
+      datetime_required: string;
+      datetime_optional?: string;
+      file_required: string;
+      file_optional?: string;
+      password_required: string;
+      password_optional?: string;
+      code_required: string;
+      code_optional?: string;
+    }[];
+  },
+);
 
 //
 // Dictionary fields (where `dict:true` is set)

package/types/inputs.test-d.ts

@@ -294,7 +294,7 @@ const choicesInputs = defineInputFields([
     choices: ['c7', 'c8'],
   },
   {
-    key: 'ignored_parent',
+    key: 'parent_key',
     children: [
       {
         key: 'child_choice',
@@ -327,4 +327,8 @@ expectType<{
   choices_list: StringHints<'c7' | 'c8'>[];
   child_choice: StringHints<'c9' | 'c10'>;
   child_choice_list: StringHints<'c11' | 'c12'>[];
+  parent_key?: Array<{
+    child_choice: StringHints<'c9' | 'c10'>;
+    child_choice_list: StringHints<'c11' | 'c12'>[];
+  }>;
 }>(choicesResult);

package/types/schemas.generated.d.ts

@@ -4,7 +4,7 @@
  * files, and/or the schema-to-ts tool and run its CLI to regenerate
  * these typings.
  *
- * zapier-platform-schema version: 17.9.1
+ * zapier-platform-schema version: 18.0.5
  *  schema-to-ts compiler version: 0.1.0
  */
 import type {

package/CHANGELOG.md

@@ -1 +0,0 @@
-See [CHANGELOG.md](https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md).