@osdk/generator 2.7.0-beta.1 → 2.7.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +78 -0
- package/build/browser/util/test/TodoWireOntology.js +2 -1
- package/build/browser/util/test/TodoWireOntology.js.map +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js +24 -4
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +1 -1
- package/build/browser/v2.0/generateMetadata.js +1 -1
- package/build/browser/v2.0/generateMetadata.js.map +1 -1
- package/build/browser/v2.0/generatePerActionDataFiles.js +12 -2
- package/build/browser/v2.0/generatePerActionDataFiles.js.map +1 -1
- package/build/cjs/index.cjs +11 -3
- package/build/cjs/index.cjs.map +1 -1
- package/build/esm/util/test/TodoWireOntology.js +2 -1
- package/build/esm/util/test/TodoWireOntology.js.map +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js +24 -4
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +1 -1
- package/build/esm/v2.0/generateMetadata.js +1 -1
- package/build/esm/v2.0/generateMetadata.js.map +1 -1
- package/build/esm/v2.0/generatePerActionDataFiles.js +12 -2
- package/build/esm/v2.0/generatePerActionDataFiles.js.map +1 -1
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,83 @@
|
|
|
1
1
|
# @osdk/generator
|
|
2
2
|
|
|
3
|
+
## 2.7.0-beta.10
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [db44f6b]
|
|
8
|
+
- Updated dependencies [24a1e29]
|
|
9
|
+
- @osdk/api@2.7.0-beta.10
|
|
10
|
+
- @osdk/generator-converters@2.7.0-beta.10
|
|
11
|
+
|
|
12
|
+
## 2.7.0-beta.9
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- @osdk/api@2.7.0-beta.9
|
|
17
|
+
- @osdk/generator-converters@2.7.0-beta.9
|
|
18
|
+
|
|
19
|
+
## 2.7.0-beta.8
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- @osdk/api@2.7.0-beta.8
|
|
24
|
+
- @osdk/generator-converters@2.7.0-beta.8
|
|
25
|
+
|
|
26
|
+
## 2.7.0-beta.7
|
|
27
|
+
|
|
28
|
+
### Patch Changes
|
|
29
|
+
|
|
30
|
+
- @osdk/api@2.7.0-beta.7
|
|
31
|
+
- @osdk/generator-converters@2.7.0-beta.7
|
|
32
|
+
|
|
33
|
+
## 2.7.0-beta.6
|
|
34
|
+
|
|
35
|
+
### Patch Changes
|
|
36
|
+
|
|
37
|
+
- Updated dependencies [c9ca08d]
|
|
38
|
+
- @osdk/api@2.7.0-beta.6
|
|
39
|
+
- @osdk/generator-converters@2.7.0-beta.6
|
|
40
|
+
|
|
41
|
+
## 2.7.0-beta.5
|
|
42
|
+
|
|
43
|
+
### Minor Changes
|
|
44
|
+
|
|
45
|
+
- dc33f68: Add Transaction ID to Queries
|
|
46
|
+
|
|
47
|
+
### Patch Changes
|
|
48
|
+
|
|
49
|
+
- Updated dependencies [dc33f68]
|
|
50
|
+
- @osdk/generator-converters@2.7.0-beta.5
|
|
51
|
+
- @osdk/api@2.7.0-beta.5
|
|
52
|
+
|
|
53
|
+
## 2.7.0-beta.4
|
|
54
|
+
|
|
55
|
+
### Patch Changes
|
|
56
|
+
|
|
57
|
+
- Updated dependencies [1e3c147]
|
|
58
|
+
- @osdk/api@2.7.0-beta.4
|
|
59
|
+
- @osdk/generator-converters@2.7.0-beta.4
|
|
60
|
+
|
|
61
|
+
## 2.7.0-beta.3
|
|
62
|
+
|
|
63
|
+
### Patch Changes
|
|
64
|
+
|
|
65
|
+
- Updated dependencies [448763f]
|
|
66
|
+
- Updated dependencies [f0a57a5]
|
|
67
|
+
- @osdk/api@2.7.0-beta.3
|
|
68
|
+
- @osdk/generator-converters@2.7.0-beta.3
|
|
69
|
+
|
|
70
|
+
## 2.7.0-beta.2
|
|
71
|
+
|
|
72
|
+
### Minor Changes
|
|
73
|
+
|
|
74
|
+
- 03db734: Move platform SDK deps to pnpm catalog
|
|
75
|
+
|
|
76
|
+
### Patch Changes
|
|
77
|
+
|
|
78
|
+
- @osdk/api@2.7.0-beta.2
|
|
79
|
+
- @osdk/generator-converters@2.7.0-beta.2
|
|
80
|
+
|
|
3
81
|
## 2.6.0-beta.13
|
|
4
82
|
|
|
5
83
|
### Minor Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TodoWireOntology.js","names":["TodoWireOntology","ontology","rid","apiName","displayName","description","actionTypes","parameters","object","dataType","type","objectApiName","objectTypeApiName","required","operations","status","objectTypes","Todo","objectType","primaryKey","pluralDisplayName","icon","name","color","titleProperty","properties","id","valueTypeApiName","body","complete","array","subType","linkTypes","cardinality","foreignKeyPropertyApiName","linkTypeRid","implementsInterfaces","implementsInterfaces2","propertiesV2","links","sharedPropertyTypeMapping","Person","email","queryTypes","output","completed","version","someTodo","interfaceTypes","SomeInterface","extendsInterfaces","implementedByObjectTypes","allProperties","allPropertiesV2","allExtendsInterfaces","allLinks","sharedPropertyTypes","SomeProperty","valueTypes","emailValueType","fieldType","constraints","options","arrayValueType","valueConstraint","uniqueValues"],"sources":["TodoWireOntology.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { WireOntologyDefinition } from \"../../WireOntologyDefinition.js\";\n\nexport const TodoWireOntology: WireOntologyDefinition = {\n ontology: {\n rid: \"ridHere\",\n apiName: \"OntologyApiName\",\n displayName: \"\",\n description: \"\",\n },\n actionTypes: {\n \"markTodoCompleted\": {\n apiName: \"markTodoCompleted\",\n description: \"An action which takes different types of parameters\",\n parameters: {\n object: {\n displayName: \"markTodoCompleted\",\n description: \"A Todo to mark completed\",\n dataType: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n required: false,\n },\n },\n rid: \"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2\",\n operations: [{\n type: \"modifyObject\",\n objectTypeApiName: \"Todo\",\n }],\n status: \"ACTIVE\",\n },\n \"deleteTodos\": {\n apiName: \"deleteTodos\",\n description: \"An action which takes in an array of objects\",\n parameters: {\n object: {\n displayName: \"deleteTodos\",\n description: \"Todo(s) to be deleted\",\n \"dataType\": {\n \"type\": \"array\",\n\n \"subType\": {\n \"type\": \"object\",\n \"objectApiName\": \"Todo\",\n \"objectTypeApiName\": \"Todo\",\n },\n },\n required: false,\n },\n },\n rid: \"ri.ontology.main.action-type.8f94017d-cf17-4fa8-84c3-8e01e5d594f2\",\n operations: [{\n type: \"deleteObject\",\n objectTypeApiName: \"Todo\",\n }],\n status: \"ACTIVE\",\n },\n },\n objectTypes: {\n Todo: {\n objectType: {\n apiName: \"Todo\",\n primaryKey: \"id\",\n displayName: \"AwesomeTodoDisplayname\",\n pluralDisplayName: \"AwesomeTodoDisplayNames\",\n icon: { type: \"blueprint\", name: \"document\", color: \"blue\" },\n description: \"Its a todo item.\",\n titleProperty: \"body\",\n properties: {\n id: {\n dataType: {\n type: \"integer\",\n },\n rid: \"rid\",\n valueTypeApiName: \"numericValueType\",\n },\n body: {\n dataType: {\n type: \"string\",\n },\n description: \"The text of the todo\",\n displayName: \"Body\",\n rid: \"rid\",\n },\n complete: {\n dataType: {\n type: \"boolean\",\n },\n rid: \"rid\",\n },\n array: {\n dataType: {\n type: \"array\",\n subType: {\n type: \"string\",\n },\n },\n valueTypeApiName: \"arrayValueType\",\n rid: \"rid\",\n },\n },\n status: \"ACTIVE\",\n rid: \"ridForTodo\",\n },\n linkTypes: [{\n apiName: \"Assignee\",\n cardinality: \"ONE\",\n displayName: \"Assignee\",\n objectTypeApiName: \"Person\",\n status: \"ACTIVE\",\n foreignKeyPropertyApiName: \"email\",\n linkTypeRid: \"\",\n }],\n implementsInterfaces: [\"SomeInterface\"],\n implementsInterfaces2: {\n \"SomeInterface\": {\n properties: {\n \"SomeProperty\": \"body\",\n },\n propertiesV2: {},\n links: {},\n },\n },\n sharedPropertyTypeMapping: {},\n },\n Person: {\n objectType: {\n apiName: \"Person\",\n primaryKey: \"email\",\n displayName: \"Person\",\n pluralDisplayName: \"Persons\",\n icon: { type: \"blueprint\", name: \"document\", color: \"blue\" },\n description: \"A person\",\n titleProperty: \"email\",\n properties: {\n email: {\n dataType: {\n type: \"string\",\n },\n rid: \"rid\",\n valueTypeApiName: \"emailValueType\",\n },\n },\n\n rid: \"ridForPerson\",\n status: \"ACTIVE\",\n },\n linkTypes: [{\n apiName: \"Todos\",\n cardinality: \"MANY\",\n displayName: \"Todos\",\n objectTypeApiName: \"Todo\",\n status: \"ACTIVE\",\n foreignKeyPropertyApiName: \"id\",\n linkTypeRid: \"\",\n }],\n implementsInterfaces: [],\n implementsInterfaces2: {},\n sharedPropertyTypeMapping: {},\n },\n },\n queryTypes: {\n \"getCount\": {\n apiName: \"getCount\",\n output: {\n type: \"integer\",\n },\n parameters: {\n completed: { dataType: { type: \"boolean\" } },\n },\n rid: \"rid.query.1\",\n version: \"1.1.0\",\n },\n \"returnsTodo\": {\n apiName: \"returnsTodo\",\n output: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n parameters: {\n someTodo: {\n description: \"Random desc so we test jsdoc\",\n dataType: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n },\n },\n rid: \"rid.query.2\",\n version: \"3.2.0\",\n },\n },\n interfaceTypes: {\n SomeInterface: {\n apiName: \"SomeInterface\",\n description: \"Some interface\",\n properties: {\n \"SomeProperty\": {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n required: false,\n },\n },\n propertiesV2: {},\n rid: \"idk\",\n displayName: \"Sum Interface\",\n extendsInterfaces: [],\n links: {},\n implementedByObjectTypes: [],\n allProperties: {\n \"SomeProperty\": {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n required: false,\n },\n },\n allPropertiesV2: {},\n allExtendsInterfaces: [],\n allLinks: {},\n },\n },\n sharedPropertyTypes: {\n SomeProperty: {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n },\n },\n valueTypes: {\n emailValueType: {\n apiName: \"emailValueType\",\n description: \"A value type for email addresses\",\n displayName: \"Email Value Type\",\n rid: \"ridForEmailValueType\",\n version: \"1.0.0\",\n fieldType: {\n type: \"string\",\n },\n constraints: [{\n type: \"enum\",\n options: [\"osdk@palantir.com\", \"foundry@palantir.com\"],\n }],\n },\n arrayValueType: {\n apiName: \"arrayValueType\",\n description: \"A value type for arrays of strings\",\n displayName: \"Array Value Type\",\n rid: \"ridForArrayValueType\",\n version: \"1.0.0\",\n fieldType: {\n type: \"array\",\n subType: {\n type: \"string\",\n },\n },\n constraints: [{\n type: \"array\",\n valueConstraint: { type: \"enum\", options: [\"a\", \"b\", \"c\"] },\n uniqueValues: false,\n }],\n },\n },\n} as const satisfies WireOntologyDefinition;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,MAAMA,gBAAwC,GAAG;EACtDC,QAAQ,EAAE;IACRC,GAAG,EAAE,SAAS;IACdC,OAAO,EAAE,iBAAiB;IAC1BC,WAAW,EAAE,EAAE;IACfC,WAAW,EAAE;EACf,CAAC;EACDC,WAAW,EAAE;IACX,mBAAmB,EAAE;MACnBH,OAAO,EAAE,mBAAmB;MAC5BE,WAAW,EAAE,qDAAqD;MAClEE,UAAU,EAAE;QACVC,MAAM,EAAE;UACNJ,WAAW,EAAE,mBAAmB;UAChCC,WAAW,EAAE,0BAA0B;UACvCI,QAAQ,EAAE;YACRC,IAAI,EAAE,QAAQ;YACdC,aAAa,EAAE,MAAM;YACrBC,iBAAiB,EAAE;UACrB,CAAC;UACDC,QAAQ,EAAE;QACZ;MACF,CAAC;MACDX,GAAG,EAAE,mEAAmE;MACxEY,UAAU,EAAE,CAAC;QACXJ,IAAI,EAAE,cAAc;QACpBE,iBAAiB,EAAE;MACrB,CAAC,CAAC;MACFG,MAAM,EAAE;IACV,CAAC;IACD,aAAa,EAAE;MACbZ,OAAO,EAAE,aAAa;MACtBE,WAAW,EAAE,8CAA8C;MAC3DE,UAAU,EAAE;QACVC,MAAM,EAAE;UACNJ,WAAW,EAAE,aAAa;UAC1BC,WAAW,EAAE,uBAAuB;UACpC,UAAU,EAAE;YACV,MAAM,EAAE,OAAO;YAEf,SAAS,EAAE;cACT,MAAM,EAAE,QAAQ;cAChB,eAAe,EAAE,MAAM;cACvB,mBAAmB,EAAE;YACvB;UACF,CAAC;UACDQ,QAAQ,EAAE;QACZ;MACF,CAAC;MACDX,GAAG,EAAE,mEAAmE;MACxEY,UAAU,EAAE,CAAC;QACXJ,IAAI,EAAE,cAAc;QACpBE,iBAAiB,EAAE;MACrB,CAAC,CAAC;MACFG,MAAM,EAAE;IACV;EACF,CAAC;EACDC,WAAW,EAAE;IACXC,IAAI,EAAE;MACJC,UAAU,EAAE;QACVf,OAAO,EAAE,MAAM;QACfgB,UAAU,EAAE,IAAI;QAChBf,WAAW,EAAE,wBAAwB;QACrCgB,iBAAiB,EAAE,yBAAyB;QAC5CC,IAAI,EAAE;UAAEX,IAAI,EAAE,WAAW;UAAEY,IAAI,EAAE,UAAU;UAAEC,KAAK,EAAE;QAAO,CAAC;QAC5DlB,WAAW,EAAE,kBAAkB;QAC/BmB,aAAa,EAAE,MAAM;QACrBC,UAAU,EAAE;UACVC,EAAE,EAAE;YACFjB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE,KAAK;YACVyB,gBAAgB,EAAE;UACpB,CAAC;UACDC,IAAI,EAAE;YACJnB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDL,WAAW,EAAE,sBAAsB;YACnCD,WAAW,EAAE,MAAM;YACnBF,GAAG,EAAE;UACP,CAAC;UACD2B,QAAQ,EAAE;YACRpB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE;UACP,CAAC;UACD4B,KAAK,EAAE;YACLrB,QAAQ,EAAE;cACRC,IAAI,EAAE,OAAO;cACbqB,OAAO,EAAE;gBACPrB,IAAI,EAAE;cACR;YACF,CAAC;YACDiB,gBAAgB,EAAE,gBAAgB;YAClCzB,GAAG,EAAE;UACP;QACF,CAAC;QACDa,MAAM,EAAE,QAAQ;QAChBb,GAAG,EAAE;MACP,CAAC;MACD8B,SAAS,EAAE,CAAC;QACV7B,OAAO,EAAE,UAAU;QACnB8B,WAAW,EAAE,KAAK;QAClB7B,WAAW,EAAE,UAAU;QACvBQ,iBAAiB,EAAE,QAAQ;QAC3BG,MAAM,EAAE,QAAQ;QAChBmB,yBAAyB,EAAE,OAAO;QAClCC,WAAW,EAAE;MACf,CAAC,CAAC;MACFC,oBAAoB,EAAE,CAAC,eAAe,CAAC;MACvCC,qBAAqB,EAAE;QACrB,eAAe,EAAE;UACfZ,UAAU,EAAE;YACV,cAAc,EAAE;UAClB,CAAC;UACDa,YAAY,EAAE,CAAC,CAAC;UAChBC,KAAK,EAAE,CAAC;QACV;MACF,CAAC;MACDC,yBAAyB,EAAE,CAAC;IAC9B,CAAC;IACDC,MAAM,EAAE;MACNvB,UAAU,EAAE;QACVf,OAAO,EAAE,QAAQ;QACjBgB,UAAU,EAAE,OAAO;QACnBf,WAAW,EAAE,QAAQ;QACrBgB,iBAAiB,EAAE,SAAS;QAC5BC,IAAI,EAAE;UAAEX,IAAI,EAAE,WAAW;UAAEY,IAAI,EAAE,UAAU;UAAEC,KAAK,EAAE;QAAO,CAAC;QAC5DlB,WAAW,EAAE,UAAU;QACvBmB,aAAa,EAAE,OAAO;QACtBC,UAAU,EAAE;UACViB,KAAK,EAAE;YACLjC,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE,KAAK;YACVyB,gBAAgB,EAAE;UACpB;QACF,CAAC;QAEDzB,GAAG,EAAE,cAAc;QACnBa,MAAM,EAAE;MACV,CAAC;MACDiB,SAAS,EAAE,CAAC;QACV7B,OAAO,EAAE,OAAO;QAChB8B,WAAW,EAAE,MAAM;QACnB7B,WAAW,EAAE,OAAO;QACpBQ,iBAAiB,EAAE,MAAM;QACzBG,MAAM,EAAE,QAAQ;QAChBmB,yBAAyB,EAAE,IAAI;QAC/BC,WAAW,EAAE;MACf,CAAC,CAAC;MACFC,oBAAoB,EAAE,EAAE;MACxBC,qBAAqB,EAAE,CAAC,CAAC;MACzBG,yBAAyB,EAAE,CAAC;IAC9B;EACF,CAAC;EACDG,UAAU,EAAE;IACV,UAAU,EAAE;MACVxC,OAAO,EAAE,UAAU;MACnByC,MAAM,EAAE;QACNlC,IAAI,EAAE;MACR,CAAC;MACDH,UAAU,EAAE;QACVsC,SAAS,EAAE;UAAEpC,QAAQ,EAAE;YAAEC,IAAI,EAAE;UAAU;QAAE;MAC7C,CAAC;MACDR,GAAG,EAAE,aAAa;MAClB4C,OAAO,EAAE;IACX,CAAC;IACD,aAAa,EAAE;MACb3C,OAAO,EAAE,aAAa;MACtByC,MAAM,EAAE;QACNlC,IAAI,EAAE,QAAQ;QACdC,aAAa,EAAE,MAAM;QACrBC,iBAAiB,EAAE;MACrB,CAAC;MACDL,UAAU,EAAE;QACVwC,QAAQ,EAAE;UACR1C,WAAW,EAAE,8BAA8B;UAC3CI,QAAQ,EAAE;YACRC,IAAI,EAAE,QAAQ;YACdC,aAAa,EAAE,MAAM;YACrBC,iBAAiB,EAAE;UACrB;QACF;MACF,CAAC;MACDV,GAAG,EAAE,aAAa;MAClB4C,OAAO,EAAE;IACX;EACF,CAAC;EACDE,cAAc,EAAE;IACdC,aAAa,EAAE;MACb9C,OAAO,EAAE,eAAe;MACxBE,WAAW,EAAE,gBAAgB;MAC7BoB,UAAU,EAAE;QACV,cAAc,EAAE;UACdtB,OAAO,EAAE,cAAc;UACvBE,WAAW,EAAE,eAAe;UAC5BD,WAAW,EAAE,cAAc;UAC3BK,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR,CAAC;UACDR,GAAG,EAAE,MAAM;UACXW,QAAQ,EAAE;QACZ;MACF,CAAC;MACDyB,YAAY,EAAE,CAAC,CAAC;MAChBpC,GAAG,EAAE,KAAK;MACVE,WAAW,EAAE,eAAe;MAC5B8C,iBAAiB,EAAE,EAAE;MACrBX,KAAK,EAAE,CAAC,CAAC;MACTY,wBAAwB,EAAE,EAAE;MAC5BC,aAAa,EAAE;QACb,cAAc,EAAE;UACdjD,OAAO,EAAE,cAAc;UACvBE,WAAW,EAAE,eAAe;UAC5BD,WAAW,EAAE,cAAc;UAC3BK,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR,CAAC;UACDR,GAAG,EAAE,MAAM;UACXW,QAAQ,EAAE;QACZ;MACF,CAAC;MACDwC,eAAe,EAAE,CAAC,CAAC;MACnBC,oBAAoB,EAAE,EAAE;MACxBC,QAAQ,EAAE,CAAC;IACb;EACF,CAAC;EACDC,mBAAmB,EAAE;IACnBC,YAAY,EAAE;MACZtD,OAAO,EAAE,cAAc;MACvBE,WAAW,EAAE,eAAe;MAC5BD,WAAW,EAAE,cAAc;MAC3BK,QAAQ,EAAE;QACRC,IAAI,EAAE;MACR,CAAC;MACDR,GAAG,EAAE;IACP;EACF,CAAC;EACDwD,UAAU,EAAE;IACVC,cAAc,EAAE;MACdxD,OAAO,EAAE,gBAAgB;MACzBE,WAAW,EAAE,kCAAkC;MAC/CD,WAAW,EAAE,kBAAkB;MAC/BF,GAAG,EAAE,sBAAsB;MAC3B4C,OAAO,EAAE,OAAO;MAChBc,SAAS,EAAE;QACTlD,IAAI,EAAE;MACR,CAAC;MACDmD,WAAW,EAAE,CAAC;QACZnD,IAAI,EAAE,MAAM;QACZoD,OAAO,EAAE,CAAC,mBAAmB,EAAE,sBAAsB;MACvD,CAAC;IACH,CAAC;IACDC,cAAc,EAAE;MACd5D,OAAO,EAAE,gBAAgB;MACzBE,WAAW,EAAE,oCAAoC;MACjDD,WAAW,EAAE,kBAAkB;MAC/BF,GAAG,EAAE,sBAAsB;MAC3B4C,OAAO,EAAE,OAAO;MAChBc,SAAS,EAAE;QACTlD,IAAI,EAAE,OAAO;QACbqB,OAAO,EAAE;UACPrB,IAAI,EAAE;QACR;MACF,CAAC;MACDmD,WAAW,EAAE,CAAC;QACZnD,IAAI,EAAE,OAAO;QACbsD,eAAe,EAAE;UAAEtD,IAAI,EAAE,MAAM;UAAEoD,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG;QAAE,CAAC;QAC3DG,YAAY,EAAE;MAChB,CAAC;IACH;EACF;AACF,CAA2C","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"TodoWireOntology.js","names":["TodoWireOntology","ontology","rid","apiName","displayName","description","actionTypes","parameters","object","dataType","type","objectApiName","objectTypeApiName","required","operations","status","objectTypes","Todo","objectType","primaryKey","pluralDisplayName","icon","name","color","titleProperty","properties","id","valueTypeApiName","body","complete","array","subType","reducers","linkTypes","cardinality","foreignKeyPropertyApiName","linkTypeRid","implementsInterfaces","implementsInterfaces2","propertiesV2","links","sharedPropertyTypeMapping","Person","email","queryTypes","output","completed","version","someTodo","interfaceTypes","SomeInterface","extendsInterfaces","implementedByObjectTypes","allProperties","allPropertiesV2","allExtendsInterfaces","allLinks","sharedPropertyTypes","SomeProperty","valueTypes","emailValueType","fieldType","constraints","options","arrayValueType","valueConstraint","uniqueValues"],"sources":["TodoWireOntology.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { WireOntologyDefinition } from \"../../WireOntologyDefinition.js\";\n\nexport const TodoWireOntology: WireOntologyDefinition = {\n ontology: {\n rid: \"ridHere\",\n apiName: \"OntologyApiName\",\n displayName: \"\",\n description: \"\",\n },\n actionTypes: {\n \"markTodoCompleted\": {\n apiName: \"markTodoCompleted\",\n description: \"An action which takes different types of parameters\",\n parameters: {\n object: {\n displayName: \"markTodoCompleted\",\n description: \"A Todo to mark completed\",\n dataType: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n required: false,\n },\n },\n rid: \"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2\",\n operations: [{\n type: \"modifyObject\",\n objectTypeApiName: \"Todo\",\n }],\n status: \"ACTIVE\",\n },\n \"deleteTodos\": {\n apiName: \"deleteTodos\",\n description: \"An action which takes in an array of objects\",\n parameters: {\n object: {\n displayName: \"deleteTodos\",\n description: \"Todo(s) to be deleted\",\n \"dataType\": {\n \"type\": \"array\",\n\n \"subType\": {\n \"type\": \"object\",\n \"objectApiName\": \"Todo\",\n \"objectTypeApiName\": \"Todo\",\n },\n },\n required: false,\n },\n },\n rid: \"ri.ontology.main.action-type.8f94017d-cf17-4fa8-84c3-8e01e5d594f2\",\n operations: [{\n type: \"deleteObject\",\n objectTypeApiName: \"Todo\",\n }],\n status: \"ACTIVE\",\n },\n },\n objectTypes: {\n Todo: {\n objectType: {\n apiName: \"Todo\",\n primaryKey: \"id\",\n displayName: \"AwesomeTodoDisplayname\",\n pluralDisplayName: \"AwesomeTodoDisplayNames\",\n icon: { type: \"blueprint\", name: \"document\", color: \"blue\" },\n description: \"Its a todo item.\",\n titleProperty: \"body\",\n properties: {\n id: {\n dataType: {\n type: \"integer\",\n },\n rid: \"rid\",\n valueTypeApiName: \"numericValueType\",\n },\n body: {\n dataType: {\n type: \"string\",\n },\n description: \"The text of the todo\",\n displayName: \"Body\",\n rid: \"rid\",\n },\n complete: {\n dataType: {\n type: \"boolean\",\n },\n rid: \"rid\",\n },\n array: {\n dataType: {\n type: \"array\",\n subType: {\n type: \"string\",\n },\n reducers: [],\n },\n valueTypeApiName: \"arrayValueType\",\n rid: \"rid\",\n },\n },\n status: \"ACTIVE\",\n rid: \"ridForTodo\",\n },\n linkTypes: [{\n apiName: \"Assignee\",\n cardinality: \"ONE\",\n displayName: \"Assignee\",\n objectTypeApiName: \"Person\",\n status: \"ACTIVE\",\n foreignKeyPropertyApiName: \"email\",\n linkTypeRid: \"\",\n }],\n implementsInterfaces: [\"SomeInterface\"],\n implementsInterfaces2: {\n \"SomeInterface\": {\n properties: {\n \"SomeProperty\": \"body\",\n },\n propertiesV2: {},\n links: {},\n },\n },\n sharedPropertyTypeMapping: {},\n },\n Person: {\n objectType: {\n apiName: \"Person\",\n primaryKey: \"email\",\n displayName: \"Person\",\n pluralDisplayName: \"Persons\",\n icon: { type: \"blueprint\", name: \"document\", color: \"blue\" },\n description: \"A person\",\n titleProperty: \"email\",\n properties: {\n email: {\n dataType: {\n type: \"string\",\n },\n rid: \"rid\",\n valueTypeApiName: \"emailValueType\",\n },\n },\n\n rid: \"ridForPerson\",\n status: \"ACTIVE\",\n },\n linkTypes: [{\n apiName: \"Todos\",\n cardinality: \"MANY\",\n displayName: \"Todos\",\n objectTypeApiName: \"Todo\",\n status: \"ACTIVE\",\n foreignKeyPropertyApiName: \"id\",\n linkTypeRid: \"\",\n }],\n implementsInterfaces: [],\n implementsInterfaces2: {},\n sharedPropertyTypeMapping: {},\n },\n },\n queryTypes: {\n \"getCount\": {\n apiName: \"getCount\",\n output: {\n type: \"integer\",\n },\n parameters: {\n completed: { dataType: { type: \"boolean\" } },\n },\n rid: \"rid.query.1\",\n version: \"1.1.0\",\n },\n \"returnsTodo\": {\n apiName: \"returnsTodo\",\n output: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n parameters: {\n someTodo: {\n description: \"Random desc so we test jsdoc\",\n dataType: {\n type: \"object\",\n objectApiName: \"Todo\",\n objectTypeApiName: \"Todo\",\n },\n },\n },\n rid: \"rid.query.2\",\n version: \"3.2.0\",\n },\n },\n interfaceTypes: {\n SomeInterface: {\n apiName: \"SomeInterface\",\n description: \"Some interface\",\n properties: {\n \"SomeProperty\": {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n required: false,\n },\n },\n propertiesV2: {},\n rid: \"idk\",\n displayName: \"Sum Interface\",\n extendsInterfaces: [],\n links: {},\n implementedByObjectTypes: [],\n allProperties: {\n \"SomeProperty\": {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n required: false,\n },\n },\n allPropertiesV2: {},\n allExtendsInterfaces: [],\n allLinks: {},\n },\n },\n sharedPropertyTypes: {\n SomeProperty: {\n apiName: \"SomeProperty\",\n description: \"Some property\",\n displayName: \"Sum Property\",\n dataType: {\n type: \"string\",\n },\n rid: \"idk2\",\n },\n },\n valueTypes: {\n emailValueType: {\n apiName: \"emailValueType\",\n description: \"A value type for email addresses\",\n displayName: \"Email Value Type\",\n rid: \"ridForEmailValueType\",\n version: \"1.0.0\",\n fieldType: {\n type: \"string\",\n },\n constraints: [{\n type: \"enum\",\n options: [\"osdk@palantir.com\", \"foundry@palantir.com\"],\n }],\n },\n arrayValueType: {\n apiName: \"arrayValueType\",\n description: \"A value type for arrays of strings\",\n displayName: \"Array Value Type\",\n rid: \"ridForArrayValueType\",\n version: \"1.0.0\",\n fieldType: {\n type: \"array\",\n subType: {\n type: \"string\",\n },\n },\n constraints: [{\n type: \"array\",\n valueConstraint: { type: \"enum\", options: [\"a\", \"b\", \"c\"] },\n uniqueValues: false,\n }],\n },\n },\n} as const satisfies WireOntologyDefinition;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,MAAMA,gBAAwC,GAAG;EACtDC,QAAQ,EAAE;IACRC,GAAG,EAAE,SAAS;IACdC,OAAO,EAAE,iBAAiB;IAC1BC,WAAW,EAAE,EAAE;IACfC,WAAW,EAAE;EACf,CAAC;EACDC,WAAW,EAAE;IACX,mBAAmB,EAAE;MACnBH,OAAO,EAAE,mBAAmB;MAC5BE,WAAW,EAAE,qDAAqD;MAClEE,UAAU,EAAE;QACVC,MAAM,EAAE;UACNJ,WAAW,EAAE,mBAAmB;UAChCC,WAAW,EAAE,0BAA0B;UACvCI,QAAQ,EAAE;YACRC,IAAI,EAAE,QAAQ;YACdC,aAAa,EAAE,MAAM;YACrBC,iBAAiB,EAAE;UACrB,CAAC;UACDC,QAAQ,EAAE;QACZ;MACF,CAAC;MACDX,GAAG,EAAE,mEAAmE;MACxEY,UAAU,EAAE,CAAC;QACXJ,IAAI,EAAE,cAAc;QACpBE,iBAAiB,EAAE;MACrB,CAAC,CAAC;MACFG,MAAM,EAAE;IACV,CAAC;IACD,aAAa,EAAE;MACbZ,OAAO,EAAE,aAAa;MACtBE,WAAW,EAAE,8CAA8C;MAC3DE,UAAU,EAAE;QACVC,MAAM,EAAE;UACNJ,WAAW,EAAE,aAAa;UAC1BC,WAAW,EAAE,uBAAuB;UACpC,UAAU,EAAE;YACV,MAAM,EAAE,OAAO;YAEf,SAAS,EAAE;cACT,MAAM,EAAE,QAAQ;cAChB,eAAe,EAAE,MAAM;cACvB,mBAAmB,EAAE;YACvB;UACF,CAAC;UACDQ,QAAQ,EAAE;QACZ;MACF,CAAC;MACDX,GAAG,EAAE,mEAAmE;MACxEY,UAAU,EAAE,CAAC;QACXJ,IAAI,EAAE,cAAc;QACpBE,iBAAiB,EAAE;MACrB,CAAC,CAAC;MACFG,MAAM,EAAE;IACV;EACF,CAAC;EACDC,WAAW,EAAE;IACXC,IAAI,EAAE;MACJC,UAAU,EAAE;QACVf,OAAO,EAAE,MAAM;QACfgB,UAAU,EAAE,IAAI;QAChBf,WAAW,EAAE,wBAAwB;QACrCgB,iBAAiB,EAAE,yBAAyB;QAC5CC,IAAI,EAAE;UAAEX,IAAI,EAAE,WAAW;UAAEY,IAAI,EAAE,UAAU;UAAEC,KAAK,EAAE;QAAO,CAAC;QAC5DlB,WAAW,EAAE,kBAAkB;QAC/BmB,aAAa,EAAE,MAAM;QACrBC,UAAU,EAAE;UACVC,EAAE,EAAE;YACFjB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE,KAAK;YACVyB,gBAAgB,EAAE;UACpB,CAAC;UACDC,IAAI,EAAE;YACJnB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDL,WAAW,EAAE,sBAAsB;YACnCD,WAAW,EAAE,MAAM;YACnBF,GAAG,EAAE;UACP,CAAC;UACD2B,QAAQ,EAAE;YACRpB,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE;UACP,CAAC;UACD4B,KAAK,EAAE;YACLrB,QAAQ,EAAE;cACRC,IAAI,EAAE,OAAO;cACbqB,OAAO,EAAE;gBACPrB,IAAI,EAAE;cACR,CAAC;cACDsB,QAAQ,EAAE;YACZ,CAAC;YACDL,gBAAgB,EAAE,gBAAgB;YAClCzB,GAAG,EAAE;UACP;QACF,CAAC;QACDa,MAAM,EAAE,QAAQ;QAChBb,GAAG,EAAE;MACP,CAAC;MACD+B,SAAS,EAAE,CAAC;QACV9B,OAAO,EAAE,UAAU;QACnB+B,WAAW,EAAE,KAAK;QAClB9B,WAAW,EAAE,UAAU;QACvBQ,iBAAiB,EAAE,QAAQ;QAC3BG,MAAM,EAAE,QAAQ;QAChBoB,yBAAyB,EAAE,OAAO;QAClCC,WAAW,EAAE;MACf,CAAC,CAAC;MACFC,oBAAoB,EAAE,CAAC,eAAe,CAAC;MACvCC,qBAAqB,EAAE;QACrB,eAAe,EAAE;UACfb,UAAU,EAAE;YACV,cAAc,EAAE;UAClB,CAAC;UACDc,YAAY,EAAE,CAAC,CAAC;UAChBC,KAAK,EAAE,CAAC;QACV;MACF,CAAC;MACDC,yBAAyB,EAAE,CAAC;IAC9B,CAAC;IACDC,MAAM,EAAE;MACNxB,UAAU,EAAE;QACVf,OAAO,EAAE,QAAQ;QACjBgB,UAAU,EAAE,OAAO;QACnBf,WAAW,EAAE,QAAQ;QACrBgB,iBAAiB,EAAE,SAAS;QAC5BC,IAAI,EAAE;UAAEX,IAAI,EAAE,WAAW;UAAEY,IAAI,EAAE,UAAU;UAAEC,KAAK,EAAE;QAAO,CAAC;QAC5DlB,WAAW,EAAE,UAAU;QACvBmB,aAAa,EAAE,OAAO;QACtBC,UAAU,EAAE;UACVkB,KAAK,EAAE;YACLlC,QAAQ,EAAE;cACRC,IAAI,EAAE;YACR,CAAC;YACDR,GAAG,EAAE,KAAK;YACVyB,gBAAgB,EAAE;UACpB;QACF,CAAC;QAEDzB,GAAG,EAAE,cAAc;QACnBa,MAAM,EAAE;MACV,CAAC;MACDkB,SAAS,EAAE,CAAC;QACV9B,OAAO,EAAE,OAAO;QAChB+B,WAAW,EAAE,MAAM;QACnB9B,WAAW,EAAE,OAAO;QACpBQ,iBAAiB,EAAE,MAAM;QACzBG,MAAM,EAAE,QAAQ;QAChBoB,yBAAyB,EAAE,IAAI;QAC/BC,WAAW,EAAE;MACf,CAAC,CAAC;MACFC,oBAAoB,EAAE,EAAE;MACxBC,qBAAqB,EAAE,CAAC,CAAC;MACzBG,yBAAyB,EAAE,CAAC;IAC9B;EACF,CAAC;EACDG,UAAU,EAAE;IACV,UAAU,EAAE;MACVzC,OAAO,EAAE,UAAU;MACnB0C,MAAM,EAAE;QACNnC,IAAI,EAAE;MACR,CAAC;MACDH,UAAU,EAAE;QACVuC,SAAS,EAAE;UAAErC,QAAQ,EAAE;YAAEC,IAAI,EAAE;UAAU;QAAE;MAC7C,CAAC;MACDR,GAAG,EAAE,aAAa;MAClB6C,OAAO,EAAE;IACX,CAAC;IACD,aAAa,EAAE;MACb5C,OAAO,EAAE,aAAa;MACtB0C,MAAM,EAAE;QACNnC,IAAI,EAAE,QAAQ;QACdC,aAAa,EAAE,MAAM;QACrBC,iBAAiB,EAAE;MACrB,CAAC;MACDL,UAAU,EAAE;QACVyC,QAAQ,EAAE;UACR3C,WAAW,EAAE,8BAA8B;UAC3CI,QAAQ,EAAE;YACRC,IAAI,EAAE,QAAQ;YACdC,aAAa,EAAE,MAAM;YACrBC,iBAAiB,EAAE;UACrB;QACF;MACF,CAAC;MACDV,GAAG,EAAE,aAAa;MAClB6C,OAAO,EAAE;IACX;EACF,CAAC;EACDE,cAAc,EAAE;IACdC,aAAa,EAAE;MACb/C,OAAO,EAAE,eAAe;MACxBE,WAAW,EAAE,gBAAgB;MAC7BoB,UAAU,EAAE;QACV,cAAc,EAAE;UACdtB,OAAO,EAAE,cAAc;UACvBE,WAAW,EAAE,eAAe;UAC5BD,WAAW,EAAE,cAAc;UAC3BK,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR,CAAC;UACDR,GAAG,EAAE,MAAM;UACXW,QAAQ,EAAE;QACZ;MACF,CAAC;MACD0B,YAAY,EAAE,CAAC,CAAC;MAChBrC,GAAG,EAAE,KAAK;MACVE,WAAW,EAAE,eAAe;MAC5B+C,iBAAiB,EAAE,EAAE;MACrBX,KAAK,EAAE,CAAC,CAAC;MACTY,wBAAwB,EAAE,EAAE;MAC5BC,aAAa,EAAE;QACb,cAAc,EAAE;UACdlD,OAAO,EAAE,cAAc;UACvBE,WAAW,EAAE,eAAe;UAC5BD,WAAW,EAAE,cAAc;UAC3BK,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR,CAAC;UACDR,GAAG,EAAE,MAAM;UACXW,QAAQ,EAAE;QACZ;MACF,CAAC;MACDyC,eAAe,EAAE,CAAC,CAAC;MACnBC,oBAAoB,EAAE,EAAE;MACxBC,QAAQ,EAAE,CAAC;IACb;EACF,CAAC;EACDC,mBAAmB,EAAE;IACnBC,YAAY,EAAE;MACZvD,OAAO,EAAE,cAAc;MACvBE,WAAW,EAAE,eAAe;MAC5BD,WAAW,EAAE,cAAc;MAC3BK,QAAQ,EAAE;QACRC,IAAI,EAAE;MACR,CAAC;MACDR,GAAG,EAAE;IACP;EACF,CAAC;EACDyD,UAAU,EAAE;IACVC,cAAc,EAAE;MACdzD,OAAO,EAAE,gBAAgB;MACzBE,WAAW,EAAE,kCAAkC;MAC/CD,WAAW,EAAE,kBAAkB;MAC/BF,GAAG,EAAE,sBAAsB;MAC3B6C,OAAO,EAAE,OAAO;MAChBc,SAAS,EAAE;QACTnD,IAAI,EAAE;MACR,CAAC;MACDoD,WAAW,EAAE,CAAC;QACZpD,IAAI,EAAE,MAAM;QACZqD,OAAO,EAAE,CAAC,mBAAmB,EAAE,sBAAsB;MACvD,CAAC;IACH,CAAC;IACDC,cAAc,EAAE;MACd7D,OAAO,EAAE,gBAAgB;MACzBE,WAAW,EAAE,oCAAoC;MACjDD,WAAW,EAAE,kBAAkB;MAC/BF,GAAG,EAAE,sBAAsB;MAC3B6C,OAAO,EAAE,OAAO;MAChBc,SAAS,EAAE;QACTnD,IAAI,EAAE,OAAO;QACbqB,OAAO,EAAE;UACPrB,IAAI,EAAE;QACR;MACF,CAAC;MACDoD,WAAW,EAAE,CAAC;QACZpD,IAAI,EAAE,OAAO;QACbuD,eAAe,EAAE;UAAEvD,IAAI,EAAE,MAAM;UAAEqD,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG;QAAE,CAAC;QAC3DG,YAAY,EAAE;MAChB,CAAC;IACH;EACF;AACF,CAA2C","ignoreList":[]}
|
|
@@ -475,7 +475,7 @@ describe("generator", () => {
|
|
|
475
475
|
/**
|
|
476
476
|
* Todo(s) to be deleted
|
|
477
477
|
*/
|
|
478
|
-
readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo
|
|
478
|
+
readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>> | null;
|
|
479
479
|
}
|
|
480
480
|
|
|
481
481
|
// Represents a fqn of the action
|
|
@@ -497,6 +497,11 @@ describe("generator", () => {
|
|
|
497
497
|
|
|
498
498
|
/**
|
|
499
499
|
* An action which takes in an array of objects
|
|
500
|
+
*
|
|
501
|
+
* **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
|
|
502
|
+
* can change the behavior of the applied action. If prefills are configured, null prevents them
|
|
503
|
+
* from being applied. If a parameter modifies an object's property, null will clear the data from
|
|
504
|
+
* the object, whereas undefined would not modify that property._
|
|
500
505
|
* @param {ActionParam.ObjectType<Todo>} [object] Todo(s) to be deleted
|
|
501
506
|
*/
|
|
502
507
|
export interface deleteTodos extends ActionDefinition<deleteTodos.Signatures> {
|
|
@@ -551,7 +556,7 @@ describe("generator", () => {
|
|
|
551
556
|
/**
|
|
552
557
|
* A Todo to mark completed
|
|
553
558
|
*/
|
|
554
|
-
readonly object?: ActionParam.ObjectType<Todo
|
|
559
|
+
readonly object?: ActionParam.ObjectType<Todo> | null;
|
|
555
560
|
}
|
|
556
561
|
|
|
557
562
|
// Represents a fqn of the action
|
|
@@ -573,6 +578,11 @@ describe("generator", () => {
|
|
|
573
578
|
|
|
574
579
|
/**
|
|
575
580
|
* An action which takes different types of parameters
|
|
581
|
+
*
|
|
582
|
+
* **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
|
|
583
|
+
* can change the behavior of the applied action. If prefills are configured, null prevents them
|
|
584
|
+
* from being applied. If a parameter modifies an object's property, null will clear the data from
|
|
585
|
+
* the object, whereas undefined would not modify that property._
|
|
576
586
|
* @param {ActionParam.ObjectType<Todo>} [object] A Todo to mark completed
|
|
577
587
|
*/
|
|
578
588
|
export interface markTodoCompleted extends ActionDefinition<markTodoCompleted.Signatures> {
|
|
@@ -1100,7 +1110,7 @@ describe("generator", () => {
|
|
|
1100
1110
|
/**
|
|
1101
1111
|
* Todo(s) to be deleted
|
|
1102
1112
|
*/
|
|
1103
|
-
readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo
|
|
1113
|
+
readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>> | null;
|
|
1104
1114
|
}
|
|
1105
1115
|
|
|
1106
1116
|
// Represents a fqn of the action
|
|
@@ -1122,6 +1132,11 @@ describe("generator", () => {
|
|
|
1122
1132
|
|
|
1123
1133
|
/**
|
|
1124
1134
|
* An action which takes in an array of objects
|
|
1135
|
+
*
|
|
1136
|
+
* **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
|
|
1137
|
+
* can change the behavior of the applied action. If prefills are configured, null prevents them
|
|
1138
|
+
* from being applied. If a parameter modifies an object's property, null will clear the data from
|
|
1139
|
+
* the object, whereas undefined would not modify that property._
|
|
1125
1140
|
* @param {ActionParam.ObjectType<Todo>} [object] Todo(s) to be deleted
|
|
1126
1141
|
*/
|
|
1127
1142
|
export interface deleteTodos extends ActionDefinition<deleteTodos.Signatures> {
|
|
@@ -1176,7 +1191,7 @@ describe("generator", () => {
|
|
|
1176
1191
|
/**
|
|
1177
1192
|
* A Todo to mark completed
|
|
1178
1193
|
*/
|
|
1179
|
-
readonly object?: ActionParam.ObjectType<Todo
|
|
1194
|
+
readonly object?: ActionParam.ObjectType<Todo> | null;
|
|
1180
1195
|
}
|
|
1181
1196
|
|
|
1182
1197
|
// Represents a fqn of the action
|
|
@@ -1198,6 +1213,11 @@ describe("generator", () => {
|
|
|
1198
1213
|
|
|
1199
1214
|
/**
|
|
1200
1215
|
* An action which takes different types of parameters
|
|
1216
|
+
*
|
|
1217
|
+
* **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
|
|
1218
|
+
* can change the behavior of the applied action. If prefills are configured, null prevents them
|
|
1219
|
+
* from being applied. If a parameter modifies an object's property, null will clear the data from
|
|
1220
|
+
* the object, whereas undefined would not modify that property._
|
|
1201
1221
|
* @param {ActionParam.ObjectType<Todo>} [object] A Todo to mark completed
|
|
1202
1222
|
*/
|
|
1203
1223
|
export interface markTodoCompleted extends ActionDefinition<markTodoCompleted.Signatures> {
|