@osdk/generator 2.0.2-rc.3 → 2.1.0-beta.0
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 +9 -32
- package/build/browser/GenerateContext/EnhanceCommon.d.ts +0 -2
- package/build/browser/GenerateContext/EnhanceCommon.d.ts.map +1 -1
- package/build/browser/GenerateContext/EnhancedBase.d.ts +1 -3
- package/build/browser/GenerateContext/EnhancedBase.d.ts.map +1 -1
- package/build/browser/GenerateContext/EnhancedBase.js +2 -11
- package/build/browser/GenerateContext/EnhancedBase.js.map +1 -1
- package/build/browser/GenerateContext/EnhancedOntologyDefinition.d.ts +4 -4
- package/build/browser/GenerateContext/EnhancedOntologyDefinition.d.ts.map +1 -1
- package/build/browser/GenerateContext/EnhancedOntologyDefinition.js +27 -21
- package/build/browser/GenerateContext/EnhancedOntologyDefinition.js.map +1 -1
- package/build/browser/GenerateContext/ForeignType.d.ts +1 -2
- package/build/browser/GenerateContext/ForeignType.d.ts.map +1 -1
- package/build/browser/GenerateContext/ForeignType.js +5 -11
- package/build/browser/GenerateContext/ForeignType.js.map +1 -1
- package/build/browser/GenerateContext/enhanceOntology.d.ts +7 -1
- package/build/browser/GenerateContext/enhanceOntology.d.ts.map +1 -1
- package/build/browser/GenerateContext/enhanceOntology.js +8 -2
- package/build/browser/GenerateContext/enhanceOntology.js.map +1 -1
- package/build/browser/generateClientSdkPackage.d.ts +1 -1
- package/build/browser/generateClientSdkPackage.d.ts.map +1 -1
- package/build/browser/generateClientSdkPackage.js +2 -2
- package/build/browser/generateClientSdkPackage.js.map +1 -1
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js +12 -6
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map +1 -1
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +40 -6
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.d.ts +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.d.ts.map +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.js +16 -80
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.js.map +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js +118 -52
- 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.test.js +14 -2
- package/build/browser/v2.0/generatePerActionDataFiles.test.js.map +1 -1
- package/build/browser/v2.0/generatePerInterfaceDataFiles.d.ts +2 -0
- package/build/browser/v2.0/generatePerInterfaceDataFiles.d.ts.map +1 -0
- package/build/browser/v2.0/generatePerInterfaceDataFiles.js +45 -0
- package/build/browser/v2.0/generatePerInterfaceDataFiles.js.map +1 -0
- package/build/browser/v2.0/generatePerObjectDataFiles.d.ts +3 -0
- package/build/browser/v2.0/generatePerObjectDataFiles.d.ts.map +1 -0
- package/build/browser/v2.0/generatePerObjectDataFiles.js +47 -0
- package/build/browser/v2.0/generatePerObjectDataFiles.js.map +1 -0
- package/build/browser/v2.0/generatePerQueryDataFiles.d.ts.map +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.js +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.js.map +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.test.js +9 -3
- package/build/browser/v2.0/generatePerQueryDataFiles.test.js.map +1 -1
- package/build/browser/v2.0/generateRootIndexTsFile.d.ts +3 -0
- package/build/browser/v2.0/generateRootIndexTsFile.d.ts.map +1 -0
- package/build/browser/v2.0/generateRootIndexTsFile.js +40 -0
- package/build/browser/v2.0/generateRootIndexTsFile.js.map +1 -0
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts.map +1 -1
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js +19 -9
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js.map +1 -1
- package/build/esm/GenerateContext/EnhanceCommon.d.ts +0 -2
- package/build/esm/GenerateContext/EnhanceCommon.d.ts.map +1 -1
- package/build/esm/GenerateContext/EnhancedBase.d.ts +1 -3
- package/build/esm/GenerateContext/EnhancedBase.d.ts.map +1 -1
- package/build/esm/GenerateContext/EnhancedBase.js +2 -11
- package/build/esm/GenerateContext/EnhancedBase.js.map +1 -1
- package/build/esm/GenerateContext/EnhancedOntologyDefinition.d.ts +4 -4
- package/build/esm/GenerateContext/EnhancedOntologyDefinition.d.ts.map +1 -1
- package/build/esm/GenerateContext/EnhancedOntologyDefinition.js +27 -21
- package/build/esm/GenerateContext/EnhancedOntologyDefinition.js.map +1 -1
- package/build/esm/GenerateContext/ForeignType.d.ts +1 -2
- package/build/esm/GenerateContext/ForeignType.d.ts.map +1 -1
- package/build/esm/GenerateContext/ForeignType.js +5 -11
- package/build/esm/GenerateContext/ForeignType.js.map +1 -1
- package/build/esm/GenerateContext/enhanceOntology.d.ts +7 -1
- package/build/esm/GenerateContext/enhanceOntology.d.ts.map +1 -1
- package/build/esm/GenerateContext/enhanceOntology.js +8 -2
- package/build/esm/GenerateContext/enhanceOntology.js.map +1 -1
- package/build/esm/generateClientSdkPackage.d.ts +1 -1
- package/build/esm/generateClientSdkPackage.d.ts.map +1 -1
- package/build/esm/generateClientSdkPackage.js +2 -2
- package/build/esm/generateClientSdkPackage.js.map +1 -1
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js +12 -6
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map +1 -1
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +40 -6
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.d.ts +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.d.ts.map +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.js +16 -80
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.js.map +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js +118 -52
- 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.test.js +14 -2
- package/build/esm/v2.0/generatePerActionDataFiles.test.js.map +1 -1
- package/build/esm/v2.0/generatePerInterfaceDataFiles.d.ts +2 -0
- package/build/esm/v2.0/generatePerInterfaceDataFiles.d.ts.map +1 -0
- package/build/esm/v2.0/generatePerInterfaceDataFiles.js +45 -0
- package/build/esm/v2.0/generatePerInterfaceDataFiles.js.map +1 -0
- package/build/esm/v2.0/generatePerObjectDataFiles.d.ts +3 -0
- package/build/esm/v2.0/generatePerObjectDataFiles.d.ts.map +1 -0
- package/build/esm/v2.0/generatePerObjectDataFiles.js +47 -0
- package/build/esm/v2.0/generatePerObjectDataFiles.js.map +1 -0
- package/build/esm/v2.0/generatePerQueryDataFiles.d.ts.map +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.js +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.js.map +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.test.js +9 -3
- package/build/esm/v2.0/generatePerQueryDataFiles.test.js.map +1 -1
- package/build/esm/v2.0/generateRootIndexTsFile.d.ts +3 -0
- package/build/esm/v2.0/generateRootIndexTsFile.d.ts.map +1 -0
- package/build/esm/v2.0/generateRootIndexTsFile.js +40 -0
- package/build/esm/v2.0/generateRootIndexTsFile.js.map +1 -0
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts.map +1 -1
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js +19 -9
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js.map +1 -1
- package/package.json +6 -6
|
@@ -227,8 +227,11 @@ const referencingOntology = {
|
|
|
227
227
|
}]
|
|
228
228
|
}
|
|
229
229
|
},
|
|
230
|
-
interfaceTypes: {
|
|
230
|
+
interfaceTypes: {
|
|
231
|
+
...referencedOntology.interfaceTypes
|
|
232
|
+
},
|
|
231
233
|
objectTypes: {
|
|
234
|
+
...referencedOntology.objectTypes,
|
|
232
235
|
"Thing": {
|
|
233
236
|
implementsInterfaces: ["com.example.dep.SomeInterface"],
|
|
234
237
|
implementsInterfaces2: {
|
|
@@ -373,13 +376,13 @@ describe("generator", () => {
|
|
|
373
376
|
|
|
374
377
|
export const $ontologyRid = 'ridHere';
|
|
375
378
|
",
|
|
376
|
-
"/foo/index.ts": "export
|
|
379
|
+
"/foo/index.ts": "export { deleteTodos, markTodoCompleted } from './ontology/actions';
|
|
377
380
|
export * as $Actions from './ontology/actions';
|
|
378
|
-
export
|
|
381
|
+
export { SomeInterface } from './ontology/interfaces';
|
|
379
382
|
export * as $Interfaces from './ontology/interfaces';
|
|
380
|
-
export
|
|
383
|
+
export { Person, Todo } from './ontology/objects';
|
|
381
384
|
export * as $Objects from './ontology/objects';
|
|
382
|
-
export
|
|
385
|
+
export { getCount, returnsTodo } from './ontology/queries';
|
|
383
386
|
export * as $Queries from './ontology/queries';
|
|
384
387
|
export { $ontologyRid } from './OntologyMetadata';
|
|
385
388
|
",
|
|
@@ -543,7 +546,7 @@ describe("generator", () => {
|
|
|
543
546
|
osdkMetadata: $osdkMetadata,
|
|
544
547
|
};
|
|
545
548
|
",
|
|
546
|
-
"/foo/ontology/interfaces.ts": "export
|
|
549
|
+
"/foo/ontology/interfaces.ts": "export { SomeInterface } from './interfaces/SomeInterface';
|
|
547
550
|
",
|
|
548
551
|
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
549
552
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
@@ -569,10 +572,16 @@ describe("generator", () => {
|
|
|
569
572
|
|
|
570
573
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
571
574
|
|
|
575
|
+
export type OsdkInstance<
|
|
576
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
577
|
+
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
578
|
+
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
579
|
+
|
|
580
|
+
/** @deprecated use OsdkInstance */
|
|
572
581
|
export type OsdkObject<
|
|
573
582
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
574
583
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
575
|
-
> =
|
|
584
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
576
585
|
}
|
|
577
586
|
|
|
578
587
|
export interface SomeInterface extends $InterfaceDefinition {
|
|
@@ -607,8 +616,8 @@ describe("generator", () => {
|
|
|
607
616
|
osdkMetadata: $osdkMetadata,
|
|
608
617
|
};
|
|
609
618
|
",
|
|
610
|
-
"/foo/ontology/objects.ts": "export
|
|
611
|
-
export
|
|
619
|
+
"/foo/ontology/objects.ts": "export { Person } from './objects/Person';
|
|
620
|
+
export { Todo } from './objects/Todo';
|
|
612
621
|
",
|
|
613
622
|
"/foo/ontology/objects/Person.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
614
623
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
@@ -643,10 +652,16 @@ describe("generator", () => {
|
|
|
643
652
|
|
|
644
653
|
export interface ObjectSet extends $ObjectSet<Person, Person.ObjectSet> {}
|
|
645
654
|
|
|
655
|
+
export type OsdkInstance<
|
|
656
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
657
|
+
K extends keyof Person.Props = keyof Person.Props,
|
|
658
|
+
> = $Osdk.Instance<Person, OPTIONS, K>;
|
|
659
|
+
|
|
660
|
+
/** @deprecated use OsdkInstance */
|
|
646
661
|
export type OsdkObject<
|
|
647
662
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
648
663
|
K extends keyof Person.Props = keyof Person.Props,
|
|
649
|
-
> =
|
|
664
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
650
665
|
}
|
|
651
666
|
|
|
652
667
|
export interface Person extends $ObjectTypeDefinition {
|
|
@@ -731,10 +746,16 @@ describe("generator", () => {
|
|
|
731
746
|
|
|
732
747
|
export interface ObjectSet extends $ObjectSet<Todo, Todo.ObjectSet> {}
|
|
733
748
|
|
|
749
|
+
export type OsdkInstance<
|
|
750
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
751
|
+
K extends keyof Todo.Props = keyof Todo.Props,
|
|
752
|
+
> = $Osdk.Instance<Todo, OPTIONS, K>;
|
|
753
|
+
|
|
754
|
+
/** @deprecated use OsdkInstance */
|
|
734
755
|
export type OsdkObject<
|
|
735
756
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
736
757
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
737
|
-
> =
|
|
758
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
738
759
|
}
|
|
739
760
|
|
|
740
761
|
export interface Todo extends $ObjectTypeDefinition {
|
|
@@ -799,8 +820,8 @@ describe("generator", () => {
|
|
|
799
820
|
osdkMetadata: $osdkMetadata,
|
|
800
821
|
};
|
|
801
822
|
",
|
|
802
|
-
"/foo/ontology/queries.ts": "export
|
|
803
|
-
export
|
|
823
|
+
"/foo/ontology/queries.ts": "export { getCount } from './queries/getCount';
|
|
824
|
+
export { returnsTodo } from './queries/returnsTodo';
|
|
804
825
|
",
|
|
805
826
|
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
806
827
|
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
@@ -924,25 +945,32 @@ describe("generator", () => {
|
|
|
924
945
|
it("throws an error if a namespace is provided that all top levels do not use", async () => {
|
|
925
946
|
await expect(generateClientSdkVersionTwoPointZero({
|
|
926
947
|
...TodoWireOntology
|
|
927
|
-
}, "", helper.minimalFiles, BASE_PATH, "module"
|
|
948
|
+
}, "", helper.minimalFiles, BASE_PATH, "module"));
|
|
949
|
+
// Disabled for now since we can't really enforce it from dev console at the moment
|
|
950
|
+
// .rejects.toThrowErrorMatchingInlineSnapshot(
|
|
951
|
+
// `[Error: Found type { ns:'undefined', shortName: 'Todo'} but it is not in the generation namespace 'foo.bar'. This violates the contract of the generator.]`,
|
|
952
|
+
// );
|
|
928
953
|
});
|
|
929
954
|
it("does not throw an error if a namespace is provided that all top levels use", async () => {
|
|
930
|
-
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, BASE_PATH, "module"
|
|
955
|
+
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, BASE_PATH, "module")).resolves.toMatchInlineSnapshot(`undefined`);
|
|
931
956
|
expect(helper.getFiles()["/foo/ontology/objects/foo.bar.Todo.ts"]).toBeUndefined();
|
|
932
957
|
expect(helper.getFiles()["/foo/ontology/objects/Todo.ts"]).not.toBeUndefined();
|
|
933
958
|
expect(tweakedFilesForSnapshotConsistency(helper.getFiles())).toMatchInlineSnapshot(`
|
|
934
959
|
{
|
|
935
960
|
"/foo/OntologyMetadata.ts": "export type $ExpectedClientVersion = 'PLACEHOLDER';
|
|
936
961
|
export const $osdkMetadata = { extraUserAgent: '' };
|
|
962
|
+
|
|
963
|
+
export const $ontologyRid = 'ridHere';
|
|
937
964
|
",
|
|
938
|
-
"/foo/index.ts": "export
|
|
965
|
+
"/foo/index.ts": "export { deleteTodos, markTodoCompleted } from './ontology/actions.js';
|
|
939
966
|
export * as $Actions from './ontology/actions.js';
|
|
940
|
-
export
|
|
967
|
+
export { SomeInterface } from './ontology/interfaces.js';
|
|
941
968
|
export * as $Interfaces from './ontology/interfaces.js';
|
|
942
|
-
export
|
|
969
|
+
export { Person, Todo } from './ontology/objects.js';
|
|
943
970
|
export * as $Objects from './ontology/objects.js';
|
|
944
|
-
export
|
|
971
|
+
export { getCount, returnsTodo } from './ontology/queries.js';
|
|
945
972
|
export * as $Queries from './ontology/queries.js';
|
|
973
|
+
export { $ontologyRid } from './OntologyMetadata.js';
|
|
946
974
|
",
|
|
947
975
|
"/foo/ontology/actions.ts": "export { deleteTodos } from './actions/deleteTodos.js';
|
|
948
976
|
export { markTodoCompleted } from './actions/markTodoCompleted.js';
|
|
@@ -1104,7 +1132,7 @@ describe("generator", () => {
|
|
|
1104
1132
|
osdkMetadata: $osdkMetadata,
|
|
1105
1133
|
};
|
|
1106
1134
|
",
|
|
1107
|
-
"/foo/ontology/interfaces.ts": "export
|
|
1135
|
+
"/foo/ontology/interfaces.ts": "export { SomeInterface } from './interfaces/SomeInterface.js';
|
|
1108
1136
|
",
|
|
1109
1137
|
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1110
1138
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1130,10 +1158,16 @@ describe("generator", () => {
|
|
|
1130
1158
|
|
|
1131
1159
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
1132
1160
|
|
|
1161
|
+
export type OsdkInstance<
|
|
1162
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1163
|
+
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1164
|
+
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
1165
|
+
|
|
1166
|
+
/** @deprecated use OsdkInstance */
|
|
1133
1167
|
export type OsdkObject<
|
|
1134
1168
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1135
1169
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1136
|
-
> =
|
|
1170
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1137
1171
|
}
|
|
1138
1172
|
|
|
1139
1173
|
export interface SomeInterface extends $InterfaceDefinition {
|
|
@@ -1168,8 +1202,8 @@ describe("generator", () => {
|
|
|
1168
1202
|
osdkMetadata: $osdkMetadata,
|
|
1169
1203
|
};
|
|
1170
1204
|
",
|
|
1171
|
-
"/foo/ontology/objects.ts": "export
|
|
1172
|
-
export
|
|
1205
|
+
"/foo/ontology/objects.ts": "export { Person } from './objects/Person.js';
|
|
1206
|
+
export { Todo } from './objects/Todo.js';
|
|
1173
1207
|
",
|
|
1174
1208
|
"/foo/ontology/objects/Person.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1175
1209
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1204,10 +1238,16 @@ describe("generator", () => {
|
|
|
1204
1238
|
|
|
1205
1239
|
export interface ObjectSet extends $ObjectSet<Person, Person.ObjectSet> {}
|
|
1206
1240
|
|
|
1241
|
+
export type OsdkInstance<
|
|
1242
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1243
|
+
K extends keyof Person.Props = keyof Person.Props,
|
|
1244
|
+
> = $Osdk.Instance<Person, OPTIONS, K>;
|
|
1245
|
+
|
|
1246
|
+
/** @deprecated use OsdkInstance */
|
|
1207
1247
|
export type OsdkObject<
|
|
1208
1248
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1209
1249
|
K extends keyof Person.Props = keyof Person.Props,
|
|
1210
|
-
> =
|
|
1250
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1211
1251
|
}
|
|
1212
1252
|
|
|
1213
1253
|
export interface Person extends $ObjectTypeDefinition {
|
|
@@ -1292,10 +1332,16 @@ describe("generator", () => {
|
|
|
1292
1332
|
|
|
1293
1333
|
export interface ObjectSet extends $ObjectSet<Todo, Todo.ObjectSet> {}
|
|
1294
1334
|
|
|
1335
|
+
export type OsdkInstance<
|
|
1336
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1337
|
+
K extends keyof Todo.Props = keyof Todo.Props,
|
|
1338
|
+
> = $Osdk.Instance<Todo, OPTIONS, K>;
|
|
1339
|
+
|
|
1340
|
+
/** @deprecated use OsdkInstance */
|
|
1295
1341
|
export type OsdkObject<
|
|
1296
1342
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1297
1343
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
1298
|
-
> =
|
|
1344
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1299
1345
|
}
|
|
1300
1346
|
|
|
1301
1347
|
export interface Todo extends $ObjectTypeDefinition {
|
|
@@ -1360,8 +1406,8 @@ describe("generator", () => {
|
|
|
1360
1406
|
osdkMetadata: $osdkMetadata,
|
|
1361
1407
|
};
|
|
1362
1408
|
",
|
|
1363
|
-
"/foo/ontology/queries.ts": "export
|
|
1364
|
-
export
|
|
1409
|
+
"/foo/ontology/queries.ts": "export { getCount } from './queries/getCount.js';
|
|
1410
|
+
export { returnsTodo } from './queries/returnsTodo.js';
|
|
1365
1411
|
",
|
|
1366
1412
|
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
1367
1413
|
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
@@ -1510,8 +1556,10 @@ describe("generator", () => {
|
|
|
1510
1556
|
});
|
|
1511
1557
|
describe("$ontologyRid", () => {
|
|
1512
1558
|
it("does not exist when an ontology api name is provided", async () => {
|
|
1513
|
-
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, "/foo", "module",
|
|
1514
|
-
expect(helper.getFiles()["/foo/index.ts"]).not.toContain(
|
|
1559
|
+
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, "/foo", "module", new Map())).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1560
|
+
// expect(helper.getFiles()["/foo/index.ts"]).not.toContain(
|
|
1561
|
+
// "$ontologyRid",
|
|
1562
|
+
// );
|
|
1515
1563
|
});
|
|
1516
1564
|
it("does exist when an ontology api name is not provided", async () => {
|
|
1517
1565
|
await expect(generateClientSdkVersionTwoPointZero(TodoWireOntology, "", helper.minimalFiles, "/foo", "module", undefined, new Map())).resolves.toMatchInlineSnapshot(`undefined`);
|
|
@@ -1520,24 +1568,24 @@ describe("generator", () => {
|
|
|
1520
1568
|
});
|
|
1521
1569
|
describe("query depends on foreign object", () => {
|
|
1522
1570
|
it("generates the correct code", async () => {
|
|
1523
|
-
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module",
|
|
1571
|
+
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module", new Map([["com.example.dep.Task", "@com.example.dep/osdk"]]), new Map([["com.example.dep.SomeInterface", "@com.example.dep/osdk"]]), new Map([["com.example.dep.spt", "@com.example.dep/osdk"]]))).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1524
1572
|
expect(helper.getFiles()["/foo/ontology/queries/getTask.ts"]).toMatchInlineSnapshot(`
|
|
1525
1573
|
"import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
1526
1574
|
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
1527
1575
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
|
|
1528
1576
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1529
|
-
import type { Task as $Imported$
|
|
1577
|
+
import type { Task as $Imported$com$example$dep$Task } from '@com.example.dep/osdk';
|
|
1530
1578
|
|
|
1531
1579
|
export namespace getTask {
|
|
1532
1580
|
export interface Signature {
|
|
1533
|
-
(query: getTask.Parameters): Promise<QueryResult.ObjectType<$Imported$
|
|
1581
|
+
(query: getTask.Parameters): Promise<QueryResult.ObjectType<$Imported$com$example$dep$Task>>;
|
|
1534
1582
|
}
|
|
1535
1583
|
|
|
1536
1584
|
export interface Parameters {
|
|
1537
1585
|
/**
|
|
1538
1586
|
* (no ontology metadata)
|
|
1539
1587
|
*/
|
|
1540
|
-
readonly a: QueryParam.ObjectType<$Imported$
|
|
1588
|
+
readonly a: QueryParam.ObjectType<$Imported$com$example$dep$Task>;
|
|
1541
1589
|
}
|
|
1542
1590
|
}
|
|
1543
1591
|
|
|
@@ -1555,14 +1603,14 @@ describe("generator", () => {
|
|
|
1555
1603
|
nullable: false;
|
|
1556
1604
|
object: 'com.example.dep.Task';
|
|
1557
1605
|
type: 'object';
|
|
1558
|
-
__OsdkTargetType?: $Imported$
|
|
1606
|
+
__OsdkTargetType?: $Imported$com$example$dep$Task;
|
|
1559
1607
|
};
|
|
1560
1608
|
};
|
|
1561
1609
|
output: {
|
|
1562
1610
|
nullable: false;
|
|
1563
1611
|
object: 'com.example.dep.Task';
|
|
1564
1612
|
type: 'object';
|
|
1565
|
-
__OsdkTargetType?: $Imported$
|
|
1613
|
+
__OsdkTargetType?: $Imported$com$example$dep$Task;
|
|
1566
1614
|
};
|
|
1567
1615
|
signature: getTask.Signature;
|
|
1568
1616
|
};
|
|
@@ -1584,7 +1632,7 @@ describe("generator", () => {
|
|
|
1584
1632
|
});
|
|
1585
1633
|
describe("object uses on foreign spt", () => {
|
|
1586
1634
|
it("stuff", async () => {
|
|
1587
|
-
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module",
|
|
1635
|
+
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module", new Map([["com.example.dep.Task", "@com.example.dep/osdk"]]), new Map([["com.example.dep.SomeInterface", "@com.example.dep/osdk"]]), new Map([["com.example.dep.spt", "@com.example.dep/osdk"]]))).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1588
1636
|
expect(helper.getFiles()["/foo/ontology/objects/UsesForeignSpt.ts"]).toMatchInlineSnapshot(`
|
|
1589
1637
|
"import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1590
1638
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1618,10 +1666,16 @@ describe("generator", () => {
|
|
|
1618
1666
|
|
|
1619
1667
|
export interface ObjectSet extends $ObjectSet<UsesForeignSpt, UsesForeignSpt.ObjectSet> {}
|
|
1620
1668
|
|
|
1669
|
+
export type OsdkInstance<
|
|
1670
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1671
|
+
K extends keyof UsesForeignSpt.Props = keyof UsesForeignSpt.Props,
|
|
1672
|
+
> = $Osdk.Instance<UsesForeignSpt, OPTIONS, K>;
|
|
1673
|
+
|
|
1674
|
+
/** @deprecated use OsdkInstance */
|
|
1621
1675
|
export type OsdkObject<
|
|
1622
1676
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1623
1677
|
K extends keyof UsesForeignSpt.Props = keyof UsesForeignSpt.Props,
|
|
1624
|
-
> =
|
|
1678
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1625
1679
|
}
|
|
1626
1680
|
|
|
1627
1681
|
export interface UsesForeignSpt extends $ObjectTypeDefinition {
|
|
@@ -1674,8 +1728,8 @@ describe("generator", () => {
|
|
|
1674
1728
|
});
|
|
1675
1729
|
});
|
|
1676
1730
|
describe("action depends on foreign object", () => {
|
|
1677
|
-
it("
|
|
1678
|
-
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module",
|
|
1731
|
+
it("can generate the action", async () => {
|
|
1732
|
+
await expect(generateClientSdkVersionTwoPointZero(referencingOntology, "", helper.minimalFiles, BASE_PATH, "module", new Map([["com.example.dep.Task", "@com.example.dep/osdk"]]), new Map([["com.example.dep.SomeInterface", "@com.example.dep/osdk"]]), new Map([["com.example.dep.spt", "@com.example.dep/osdk"]]))).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1679
1733
|
expect(helper.getFiles()["/foo/ontology/actions/setTaskBody.ts"]).toMatchInlineSnapshot(`
|
|
1680
1734
|
"import type {
|
|
1681
1735
|
ActionDefinition,
|
|
@@ -1686,7 +1740,7 @@ describe("generator", () => {
|
|
|
1686
1740
|
ApplyBatchActionOptions,
|
|
1687
1741
|
} from '@osdk/api';
|
|
1688
1742
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1689
|
-
import type { Task as $Imported$
|
|
1743
|
+
import type { Task as $Imported$com$example$dep$Task } from '@com.example.dep/osdk';
|
|
1690
1744
|
|
|
1691
1745
|
export namespace setTaskBody {
|
|
1692
1746
|
// Represents the definition of the parameters for the action
|
|
@@ -1699,14 +1753,14 @@ describe("generator", () => {
|
|
|
1699
1753
|
task: {
|
|
1700
1754
|
multiplicity: false;
|
|
1701
1755
|
nullable: false;
|
|
1702
|
-
type: ActionMetadata.DataType.Object<$Imported$
|
|
1756
|
+
type: ActionMetadata.DataType.Object<$Imported$com$example$dep$Task>;
|
|
1703
1757
|
};
|
|
1704
1758
|
};
|
|
1705
1759
|
|
|
1706
1760
|
export interface Params {
|
|
1707
1761
|
readonly body: ActionParam.PrimitiveType<'string'>;
|
|
1708
1762
|
|
|
1709
|
-
readonly task: ActionParam.ObjectType<$Imported$
|
|
1763
|
+
readonly task: ActionParam.ObjectType<$Imported$com$example$dep$Task>;
|
|
1710
1764
|
}
|
|
1711
1765
|
|
|
1712
1766
|
// Represents a fqn of the action
|
|
@@ -1725,7 +1779,7 @@ describe("generator", () => {
|
|
|
1725
1779
|
|
|
1726
1780
|
/**
|
|
1727
1781
|
* @param {ActionParam.PrimitiveType<"string">} body
|
|
1728
|
-
* @param {ActionParam.ObjectType<$Imported$
|
|
1782
|
+
* @param {ActionParam.ObjectType<$Imported$com$example$dep$Task>} task
|
|
1729
1783
|
*/
|
|
1730
1784
|
export interface setTaskBody extends ActionDefinition<setTaskBody.Signatures> {
|
|
1731
1785
|
__DefinitionMetadata?: {
|
|
@@ -1758,7 +1812,7 @@ describe("generator", () => {
|
|
|
1758
1812
|
});
|
|
1759
1813
|
});
|
|
1760
1814
|
it("can generate an sdk package that is entirely a library", async () => {
|
|
1761
|
-
await expect(generateClientSdkVersionTwoPointZero(referencedOntology, "", helper.minimalFiles, BASE_PATH, "module"
|
|
1815
|
+
await expect(generateClientSdkVersionTwoPointZero(referencedOntology, "", helper.minimalFiles, BASE_PATH, "module")).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1762
1816
|
expect(tweakedFilesForSnapshotConsistency(helper.getFiles())).toMatchInlineSnapshot(`
|
|
1763
1817
|
{
|
|
1764
1818
|
"/foo/OntologyMetadata.ts": "export type $ExpectedClientVersion = 'PLACEHOLDER';
|
|
@@ -1766,19 +1820,19 @@ describe("generator", () => {
|
|
|
1766
1820
|
|
|
1767
1821
|
export const $ontologyRid = 'ri.ontology.main.ontology.dep';
|
|
1768
1822
|
",
|
|
1769
|
-
"/foo/index.ts": "export
|
|
1823
|
+
"/foo/index.ts": "export {} from './ontology/actions.js';
|
|
1770
1824
|
export * as $Actions from './ontology/actions.js';
|
|
1771
|
-
export
|
|
1825
|
+
export { SomeInterface } from './ontology/interfaces.js';
|
|
1772
1826
|
export * as $Interfaces from './ontology/interfaces.js';
|
|
1773
|
-
export
|
|
1827
|
+
export { Task } from './ontology/objects.js';
|
|
1774
1828
|
export * as $Objects from './ontology/objects.js';
|
|
1775
|
-
export
|
|
1829
|
+
export {} from './ontology/queries.js';
|
|
1776
1830
|
export * as $Queries from './ontology/queries.js';
|
|
1777
1831
|
export { $ontologyRid } from './OntologyMetadata.js';
|
|
1778
1832
|
",
|
|
1779
1833
|
"/foo/ontology/actions.ts": "export {};
|
|
1780
1834
|
",
|
|
1781
|
-
"/foo/ontology/interfaces.ts": "export
|
|
1835
|
+
"/foo/ontology/interfaces.ts": "export { SomeInterface } from './interfaces/SomeInterface.js';
|
|
1782
1836
|
",
|
|
1783
1837
|
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1784
1838
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1804,10 +1858,16 @@ describe("generator", () => {
|
|
|
1804
1858
|
|
|
1805
1859
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
1806
1860
|
|
|
1861
|
+
export type OsdkInstance<
|
|
1862
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1863
|
+
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1864
|
+
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
1865
|
+
|
|
1866
|
+
/** @deprecated use OsdkInstance */
|
|
1807
1867
|
export type OsdkObject<
|
|
1808
1868
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1809
1869
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1810
|
-
> =
|
|
1870
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1811
1871
|
}
|
|
1812
1872
|
|
|
1813
1873
|
export interface SomeInterface extends $InterfaceDefinition {
|
|
@@ -1840,7 +1900,7 @@ describe("generator", () => {
|
|
|
1840
1900
|
osdkMetadata: $osdkMetadata,
|
|
1841
1901
|
};
|
|
1842
1902
|
",
|
|
1843
|
-
"/foo/ontology/objects.ts": "export
|
|
1903
|
+
"/foo/ontology/objects.ts": "export { Task } from './objects/Task.js';
|
|
1844
1904
|
",
|
|
1845
1905
|
"/foo/ontology/objects/Task.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1846
1906
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1874,10 +1934,16 @@ describe("generator", () => {
|
|
|
1874
1934
|
|
|
1875
1935
|
export interface ObjectSet extends $ObjectSet<Task, Task.ObjectSet> {}
|
|
1876
1936
|
|
|
1937
|
+
export type OsdkInstance<
|
|
1938
|
+
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1939
|
+
K extends keyof Task.Props = keyof Task.Props,
|
|
1940
|
+
> = $Osdk.Instance<Task, OPTIONS, K>;
|
|
1941
|
+
|
|
1942
|
+
/** @deprecated use OsdkInstance */
|
|
1877
1943
|
export type OsdkObject<
|
|
1878
1944
|
OPTIONS extends never | '$notStrict' | '$rid' = never,
|
|
1879
1945
|
K extends keyof Task.Props = keyof Task.Props,
|
|
1880
|
-
> =
|
|
1946
|
+
> = OsdkInstance<OPTIONS, K>;
|
|
1881
1947
|
}
|
|
1882
1948
|
|
|
1883
1949
|
export interface Task extends $ObjectTypeDefinition {
|