@osdk/generator 2.1.0-beta.0 → 2.1.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 +121 -0
- package/build/browser/GenerateContext/GenerateContext.d.ts +1 -0
- package/build/browser/GenerateContext/GenerateContext.d.ts.map +1 -1
- package/build/browser/generateClientSdkPackage.test.js +2 -2
- package/build/browser/generateClientSdkPackage.test.js.map +1 -1
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js +6 -6
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map +1 -1
- package/build/browser/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +12 -19
- 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 +3 -2
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.js.map +1 -1
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js +67 -86
- package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +1 -1
- package/build/browser/v2.0/generatePerActionDataFiles.d.ts +1 -1
- package/build/browser/v2.0/generatePerActionDataFiles.d.ts.map +1 -1
- package/build/browser/v2.0/generatePerActionDataFiles.js +5 -4
- package/build/browser/v2.0/generatePerActionDataFiles.js.map +1 -1
- package/build/browser/v2.0/generatePerInterfaceDataFiles.js +4 -3
- package/build/browser/v2.0/generatePerInterfaceDataFiles.js.map +1 -1
- package/build/browser/v2.0/generatePerObjectDataFiles.d.ts.map +1 -1
- package/build/browser/v2.0/generatePerObjectDataFiles.js +1 -1
- package/build/browser/v2.0/generatePerObjectDataFiles.js.map +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.d.ts +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.d.ts.map +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.js +30 -16
- package/build/browser/v2.0/generatePerQueryDataFiles.js.map +1 -1
- package/build/browser/v2.0/generatePerQueryDataFiles.test.js +259 -7
- package/build/browser/v2.0/generatePerQueryDataFiles.test.js.map +1 -1
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts +0 -1
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts.map +1 -1
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js +14 -12
- package/build/browser/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js.map +1 -1
- package/build/browser/validateWireOntologyAssumptions.js +2 -2
- package/build/browser/validateWireOntologyAssumptions.js.map +1 -1
- package/build/esm/GenerateContext/GenerateContext.d.ts +1 -0
- package/build/esm/GenerateContext/GenerateContext.d.ts.map +1 -1
- package/build/esm/generateClientSdkPackage.test.js +2 -2
- package/build/esm/generateClientSdkPackage.test.js.map +1 -1
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js +6 -6
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map +1 -1
- package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js +12 -19
- 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 +3 -2
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.js.map +1 -1
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js +67 -86
- package/build/esm/v2.0/generateClientSdkVersionTwoPointZero.test.js.map +1 -1
- package/build/esm/v2.0/generatePerActionDataFiles.d.ts +1 -1
- package/build/esm/v2.0/generatePerActionDataFiles.d.ts.map +1 -1
- package/build/esm/v2.0/generatePerActionDataFiles.js +5 -4
- package/build/esm/v2.0/generatePerActionDataFiles.js.map +1 -1
- package/build/esm/v2.0/generatePerInterfaceDataFiles.js +4 -3
- package/build/esm/v2.0/generatePerInterfaceDataFiles.js.map +1 -1
- package/build/esm/v2.0/generatePerObjectDataFiles.d.ts.map +1 -1
- package/build/esm/v2.0/generatePerObjectDataFiles.js +1 -1
- package/build/esm/v2.0/generatePerObjectDataFiles.js.map +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.d.ts +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.d.ts.map +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.js +30 -16
- package/build/esm/v2.0/generatePerQueryDataFiles.js.map +1 -1
- package/build/esm/v2.0/generatePerQueryDataFiles.test.js +259 -7
- package/build/esm/v2.0/generatePerQueryDataFiles.test.js.map +1 -1
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts +0 -1
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.d.ts.map +1 -1
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js +14 -12
- package/build/esm/v2.0/wireObjectTypeV2ToSdkObjectConstV2.js.map +1 -1
- package/build/esm/validateWireOntologyAssumptions.js +2 -2
- package/build/esm/validateWireOntologyAssumptions.js.map +1 -1
- package/package.json +11 -9
|
@@ -396,7 +396,7 @@ describe("generator", () => {
|
|
|
396
396
|
ActionReturnTypeForOptions,
|
|
397
397
|
ApplyActionOptions,
|
|
398
398
|
ApplyBatchActionOptions,
|
|
399
|
-
} from '@osdk/
|
|
399
|
+
} from '@osdk/client';
|
|
400
400
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
401
401
|
import type { Todo } from '../objects/Todo';
|
|
402
402
|
|
|
@@ -472,7 +472,7 @@ describe("generator", () => {
|
|
|
472
472
|
ActionReturnTypeForOptions,
|
|
473
473
|
ApplyActionOptions,
|
|
474
474
|
ApplyBatchActionOptions,
|
|
475
|
-
} from '@osdk/
|
|
475
|
+
} from '@osdk/client';
|
|
476
476
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
477
477
|
import type { Todo } from '../objects/Todo';
|
|
478
478
|
|
|
@@ -548,7 +548,7 @@ describe("generator", () => {
|
|
|
548
548
|
",
|
|
549
549
|
"/foo/ontology/interfaces.ts": "export { SomeInterface } from './interfaces/SomeInterface';
|
|
550
550
|
",
|
|
551
|
-
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/
|
|
551
|
+
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
|
|
552
552
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
553
553
|
|
|
554
554
|
import type {
|
|
@@ -556,7 +556,7 @@ describe("generator", () => {
|
|
|
556
556
|
ObjectSet as $ObjectSet,
|
|
557
557
|
Osdk as $Osdk,
|
|
558
558
|
PropertyValueWireToClient as $PropType,
|
|
559
|
-
} from '@osdk/
|
|
559
|
+
} from '@osdk/client';
|
|
560
560
|
|
|
561
561
|
export type OsdkObjectLinks$SomeInterface = {};
|
|
562
562
|
|
|
@@ -566,20 +566,18 @@ describe("generator", () => {
|
|
|
566
566
|
export interface Props {
|
|
567
567
|
readonly SomeProperty: $PropType['string'] | undefined;
|
|
568
568
|
}
|
|
569
|
-
export
|
|
570
|
-
readonly SomeProperty: $PropType['string'] | undefined;
|
|
571
|
-
}
|
|
569
|
+
export type StrictProps = Props;
|
|
572
570
|
|
|
573
571
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
574
572
|
|
|
575
573
|
export type OsdkInstance<
|
|
576
|
-
OPTIONS extends never | '$
|
|
574
|
+
OPTIONS extends never | '$rid' = never,
|
|
577
575
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
578
576
|
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
579
577
|
|
|
580
578
|
/** @deprecated use OsdkInstance */
|
|
581
579
|
export type OsdkObject<
|
|
582
|
-
OPTIONS extends never | '$
|
|
580
|
+
OPTIONS extends never | '$rid' = never,
|
|
583
581
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
584
582
|
> = OsdkInstance<OPTIONS, K>;
|
|
585
583
|
}
|
|
@@ -619,7 +617,7 @@ describe("generator", () => {
|
|
|
619
617
|
"/foo/ontology/objects.ts": "export { Person } from './objects/Person';
|
|
620
618
|
export { Todo } from './objects/Todo';
|
|
621
619
|
",
|
|
622
|
-
"/foo/ontology/objects/Person.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/
|
|
620
|
+
"/foo/ontology/objects/Person.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
|
|
623
621
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
624
622
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata';
|
|
625
623
|
import type { Todo } from './Todo';
|
|
@@ -627,14 +625,14 @@ describe("generator", () => {
|
|
|
627
625
|
PropertyKeys as $PropertyKeys,
|
|
628
626
|
ObjectTypeDefinition as $ObjectTypeDefinition,
|
|
629
627
|
ObjectMetadata as $ObjectMetadata,
|
|
630
|
-
} from '@osdk/
|
|
628
|
+
} from '@osdk/client';
|
|
631
629
|
import type {
|
|
632
630
|
ObjectSet as $ObjectSet,
|
|
633
631
|
Osdk as $Osdk,
|
|
634
632
|
OsdkObject as $OsdkObject,
|
|
635
633
|
PropertyValueWireToClient as $PropType,
|
|
636
634
|
SingleLinkAccessor as $SingleLinkAccessor,
|
|
637
|
-
} from '@osdk/
|
|
635
|
+
} from '@osdk/client';
|
|
638
636
|
|
|
639
637
|
export namespace Person {
|
|
640
638
|
export type PropertyKeys = 'email';
|
|
@@ -644,22 +642,20 @@ describe("generator", () => {
|
|
|
644
642
|
}
|
|
645
643
|
|
|
646
644
|
export interface Props {
|
|
647
|
-
readonly email: $PropType['string'] | undefined;
|
|
648
|
-
}
|
|
649
|
-
export interface StrictProps {
|
|
650
645
|
readonly email: $PropType['string'];
|
|
651
646
|
}
|
|
647
|
+
export type StrictProps = Props;
|
|
652
648
|
|
|
653
649
|
export interface ObjectSet extends $ObjectSet<Person, Person.ObjectSet> {}
|
|
654
650
|
|
|
655
651
|
export type OsdkInstance<
|
|
656
|
-
OPTIONS extends never | '$
|
|
652
|
+
OPTIONS extends never | '$rid' = never,
|
|
657
653
|
K extends keyof Person.Props = keyof Person.Props,
|
|
658
654
|
> = $Osdk.Instance<Person, OPTIONS, K>;
|
|
659
655
|
|
|
660
656
|
/** @deprecated use OsdkInstance */
|
|
661
657
|
export type OsdkObject<
|
|
662
|
-
OPTIONS extends never | '$
|
|
658
|
+
OPTIONS extends never | '$rid' = never,
|
|
663
659
|
K extends keyof Person.Props = keyof Person.Props,
|
|
664
660
|
> = OsdkInstance<OPTIONS, K>;
|
|
665
661
|
}
|
|
@@ -709,7 +705,7 @@ describe("generator", () => {
|
|
|
709
705
|
osdkMetadata: $osdkMetadata,
|
|
710
706
|
};
|
|
711
707
|
",
|
|
712
|
-
"/foo/ontology/objects/Todo.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/
|
|
708
|
+
"/foo/ontology/objects/Todo.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
|
|
713
709
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
714
710
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata';
|
|
715
711
|
import type { Person } from './Person';
|
|
@@ -717,14 +713,14 @@ describe("generator", () => {
|
|
|
717
713
|
PropertyKeys as $PropertyKeys,
|
|
718
714
|
ObjectTypeDefinition as $ObjectTypeDefinition,
|
|
719
715
|
ObjectMetadata as $ObjectMetadata,
|
|
720
|
-
} from '@osdk/
|
|
716
|
+
} from '@osdk/client';
|
|
721
717
|
import type {
|
|
722
718
|
ObjectSet as $ObjectSet,
|
|
723
719
|
Osdk as $Osdk,
|
|
724
720
|
OsdkObject as $OsdkObject,
|
|
725
721
|
PropertyValueWireToClient as $PropType,
|
|
726
722
|
SingleLinkAccessor as $SingleLinkAccessor,
|
|
727
|
-
} from '@osdk/
|
|
723
|
+
} from '@osdk/client';
|
|
728
724
|
|
|
729
725
|
export namespace Todo {
|
|
730
726
|
export type PropertyKeys = 'id' | 'body' | 'complete';
|
|
@@ -734,26 +730,22 @@ describe("generator", () => {
|
|
|
734
730
|
}
|
|
735
731
|
|
|
736
732
|
export interface Props {
|
|
737
|
-
readonly body: $PropType['string'] | undefined;
|
|
738
|
-
readonly complete: $PropType['boolean'] | undefined;
|
|
739
|
-
readonly id: $PropType['integer'] | undefined;
|
|
740
|
-
}
|
|
741
|
-
export interface StrictProps {
|
|
742
733
|
readonly body: $PropType['string'] | undefined;
|
|
743
734
|
readonly complete: $PropType['boolean'] | undefined;
|
|
744
735
|
readonly id: $PropType['integer'];
|
|
745
736
|
}
|
|
737
|
+
export type StrictProps = Props;
|
|
746
738
|
|
|
747
739
|
export interface ObjectSet extends $ObjectSet<Todo, Todo.ObjectSet> {}
|
|
748
740
|
|
|
749
741
|
export type OsdkInstance<
|
|
750
|
-
OPTIONS extends never | '$
|
|
742
|
+
OPTIONS extends never | '$rid' = never,
|
|
751
743
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
752
744
|
> = $Osdk.Instance<Todo, OPTIONS, K>;
|
|
753
745
|
|
|
754
746
|
/** @deprecated use OsdkInstance */
|
|
755
747
|
export type OsdkObject<
|
|
756
|
-
OPTIONS extends never | '$
|
|
748
|
+
OPTIONS extends never | '$rid' = never,
|
|
757
749
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
758
750
|
> = OsdkInstance<OPTIONS, K>;
|
|
759
751
|
}
|
|
@@ -823,14 +815,13 @@ describe("generator", () => {
|
|
|
823
815
|
"/foo/ontology/queries.ts": "export { getCount } from './queries/getCount';
|
|
824
816
|
export { returnsTodo } from './queries/returnsTodo';
|
|
825
817
|
",
|
|
826
|
-
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, VersionBound } from '@osdk/
|
|
827
|
-
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
818
|
+
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
|
|
828
819
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata';
|
|
829
820
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
830
821
|
|
|
831
822
|
export namespace getCount {
|
|
832
823
|
export interface Signature {
|
|
833
|
-
(query: getCount.Parameters): Promise<
|
|
824
|
+
(query: getCount.Parameters): Promise<getCount.ReturnType>;
|
|
834
825
|
}
|
|
835
826
|
|
|
836
827
|
export interface Parameters {
|
|
@@ -839,6 +830,8 @@ describe("generator", () => {
|
|
|
839
830
|
*/
|
|
840
831
|
readonly completed: QueryParam.PrimitiveType<'boolean'>;
|
|
841
832
|
}
|
|
833
|
+
|
|
834
|
+
export type ReturnType = QueryResult.PrimitiveType<'integer'>;
|
|
842
835
|
}
|
|
843
836
|
|
|
844
837
|
export interface getCount extends QueryDefinition<getCount.Signature>, VersionBound<$ExpectedClientVersion> {
|
|
@@ -875,15 +868,14 @@ describe("generator", () => {
|
|
|
875
868
|
osdkMetadata: $osdkMetadata,
|
|
876
869
|
};
|
|
877
870
|
",
|
|
878
|
-
"/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, VersionBound } from '@osdk/
|
|
879
|
-
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
871
|
+
"/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/client';
|
|
880
872
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata';
|
|
881
873
|
import { $osdkMetadata } from '../../OntologyMetadata';
|
|
882
874
|
import type { Todo } from '../objects/Todo';
|
|
883
875
|
|
|
884
876
|
export namespace returnsTodo {
|
|
885
877
|
export interface Signature {
|
|
886
|
-
(query: returnsTodo.Parameters): Promise<
|
|
878
|
+
(query: returnsTodo.Parameters): Promise<returnsTodo.ReturnType>;
|
|
887
879
|
}
|
|
888
880
|
|
|
889
881
|
export interface Parameters {
|
|
@@ -892,6 +884,8 @@ describe("generator", () => {
|
|
|
892
884
|
*/
|
|
893
885
|
readonly someTodo: QueryParam.ObjectType<Todo>;
|
|
894
886
|
}
|
|
887
|
+
|
|
888
|
+
export type ReturnType = QueryResult.ObjectType<Todo>;
|
|
895
889
|
}
|
|
896
890
|
|
|
897
891
|
export interface returnsTodo extends QueryDefinition<returnsTodo.Signature>, VersionBound<$ExpectedClientVersion> {
|
|
@@ -945,14 +939,14 @@ describe("generator", () => {
|
|
|
945
939
|
it("throws an error if a namespace is provided that all top levels do not use", async () => {
|
|
946
940
|
await expect(generateClientSdkVersionTwoPointZero({
|
|
947
941
|
...TodoWireOntology
|
|
948
|
-
}, "", helper.minimalFiles, BASE_PATH, "module"));
|
|
942
|
+
}, "", helper.minimalFiles, BASE_PATH, "module", undefined, undefined, undefined, true));
|
|
949
943
|
// Disabled for now since we can't really enforce it from dev console at the moment
|
|
950
944
|
// .rejects.toThrowErrorMatchingInlineSnapshot(
|
|
951
945
|
// `[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
946
|
// );
|
|
953
947
|
});
|
|
954
948
|
it("does not throw an error if a namespace is provided that all top levels use", async () => {
|
|
955
|
-
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, BASE_PATH, "module")).resolves.toMatchInlineSnapshot(`undefined`);
|
|
949
|
+
await expect(generateClientSdkVersionTwoPointZero(fooBarTodoWireOntology, "", helper.minimalFiles, BASE_PATH, "module", undefined, undefined, undefined, true)).resolves.toMatchInlineSnapshot(`undefined`);
|
|
956
950
|
expect(helper.getFiles()["/foo/ontology/objects/foo.bar.Todo.ts"]).toBeUndefined();
|
|
957
951
|
expect(helper.getFiles()["/foo/ontology/objects/Todo.ts"]).not.toBeUndefined();
|
|
958
952
|
expect(tweakedFilesForSnapshotConsistency(helper.getFiles())).toMatchInlineSnapshot(`
|
|
@@ -1152,20 +1146,18 @@ describe("generator", () => {
|
|
|
1152
1146
|
export interface Props {
|
|
1153
1147
|
readonly SomeProperty: $PropType['string'] | undefined;
|
|
1154
1148
|
}
|
|
1155
|
-
export
|
|
1156
|
-
readonly SomeProperty: $PropType['string'] | undefined;
|
|
1157
|
-
}
|
|
1149
|
+
export type StrictProps = Props;
|
|
1158
1150
|
|
|
1159
1151
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
1160
1152
|
|
|
1161
1153
|
export type OsdkInstance<
|
|
1162
|
-
OPTIONS extends never | '$
|
|
1154
|
+
OPTIONS extends never | '$rid' = never,
|
|
1163
1155
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1164
1156
|
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
1165
1157
|
|
|
1166
1158
|
/** @deprecated use OsdkInstance */
|
|
1167
1159
|
export type OsdkObject<
|
|
1168
|
-
OPTIONS extends never | '$
|
|
1160
|
+
OPTIONS extends never | '$rid' = never,
|
|
1169
1161
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1170
1162
|
> = OsdkInstance<OPTIONS, K>;
|
|
1171
1163
|
}
|
|
@@ -1230,22 +1222,20 @@ describe("generator", () => {
|
|
|
1230
1222
|
}
|
|
1231
1223
|
|
|
1232
1224
|
export interface Props {
|
|
1233
|
-
readonly email: $PropType['string'] | undefined;
|
|
1234
|
-
}
|
|
1235
|
-
export interface StrictProps {
|
|
1236
1225
|
readonly email: $PropType['string'];
|
|
1237
1226
|
}
|
|
1227
|
+
export type StrictProps = Props;
|
|
1238
1228
|
|
|
1239
1229
|
export interface ObjectSet extends $ObjectSet<Person, Person.ObjectSet> {}
|
|
1240
1230
|
|
|
1241
1231
|
export type OsdkInstance<
|
|
1242
|
-
OPTIONS extends never | '$
|
|
1232
|
+
OPTIONS extends never | '$rid' = never,
|
|
1243
1233
|
K extends keyof Person.Props = keyof Person.Props,
|
|
1244
1234
|
> = $Osdk.Instance<Person, OPTIONS, K>;
|
|
1245
1235
|
|
|
1246
1236
|
/** @deprecated use OsdkInstance */
|
|
1247
1237
|
export type OsdkObject<
|
|
1248
|
-
OPTIONS extends never | '$
|
|
1238
|
+
OPTIONS extends never | '$rid' = never,
|
|
1249
1239
|
K extends keyof Person.Props = keyof Person.Props,
|
|
1250
1240
|
> = OsdkInstance<OPTIONS, K>;
|
|
1251
1241
|
}
|
|
@@ -1320,26 +1310,22 @@ describe("generator", () => {
|
|
|
1320
1310
|
}
|
|
1321
1311
|
|
|
1322
1312
|
export interface Props {
|
|
1323
|
-
readonly body: $PropType['string'] | undefined;
|
|
1324
|
-
readonly complete: $PropType['boolean'] | undefined;
|
|
1325
|
-
readonly id: $PropType['integer'] | undefined;
|
|
1326
|
-
}
|
|
1327
|
-
export interface StrictProps {
|
|
1328
1313
|
readonly body: $PropType['string'] | undefined;
|
|
1329
1314
|
readonly complete: $PropType['boolean'] | undefined;
|
|
1330
1315
|
readonly id: $PropType['integer'];
|
|
1331
1316
|
}
|
|
1317
|
+
export type StrictProps = Props;
|
|
1332
1318
|
|
|
1333
1319
|
export interface ObjectSet extends $ObjectSet<Todo, Todo.ObjectSet> {}
|
|
1334
1320
|
|
|
1335
1321
|
export type OsdkInstance<
|
|
1336
|
-
OPTIONS extends never | '$
|
|
1322
|
+
OPTIONS extends never | '$rid' = never,
|
|
1337
1323
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
1338
1324
|
> = $Osdk.Instance<Todo, OPTIONS, K>;
|
|
1339
1325
|
|
|
1340
1326
|
/** @deprecated use OsdkInstance */
|
|
1341
1327
|
export type OsdkObject<
|
|
1342
|
-
OPTIONS extends never | '$
|
|
1328
|
+
OPTIONS extends never | '$rid' = never,
|
|
1343
1329
|
K extends keyof Todo.Props = keyof Todo.Props,
|
|
1344
1330
|
> = OsdkInstance<OPTIONS, K>;
|
|
1345
1331
|
}
|
|
@@ -1409,14 +1395,13 @@ describe("generator", () => {
|
|
|
1409
1395
|
"/foo/ontology/queries.ts": "export { getCount } from './queries/getCount.js';
|
|
1410
1396
|
export { returnsTodo } from './queries/returnsTodo.js';
|
|
1411
1397
|
",
|
|
1412
|
-
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
1413
|
-
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
1398
|
+
"/foo/ontology/queries/getCount.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
|
|
1414
1399
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
|
|
1415
1400
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1416
1401
|
|
|
1417
1402
|
export namespace getCount {
|
|
1418
1403
|
export interface Signature {
|
|
1419
|
-
(query: getCount.Parameters): Promise<
|
|
1404
|
+
(query: getCount.Parameters): Promise<getCount.ReturnType>;
|
|
1420
1405
|
}
|
|
1421
1406
|
|
|
1422
1407
|
export interface Parameters {
|
|
@@ -1425,6 +1410,8 @@ describe("generator", () => {
|
|
|
1425
1410
|
*/
|
|
1426
1411
|
readonly completed: QueryParam.PrimitiveType<'boolean'>;
|
|
1427
1412
|
}
|
|
1413
|
+
|
|
1414
|
+
export type ReturnType = QueryResult.PrimitiveType<'integer'>;
|
|
1428
1415
|
}
|
|
1429
1416
|
|
|
1430
1417
|
export interface getCount extends QueryDefinition<getCount.Signature>, VersionBound<$ExpectedClientVersion> {
|
|
@@ -1461,15 +1448,14 @@ describe("generator", () => {
|
|
|
1461
1448
|
osdkMetadata: $osdkMetadata,
|
|
1462
1449
|
};
|
|
1463
1450
|
",
|
|
1464
|
-
"/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
1465
|
-
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
1451
|
+
"/foo/ontology/queries/returnsTodo.ts": "import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
|
|
1466
1452
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
|
|
1467
1453
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1468
1454
|
import type { Todo } from '../objects/Todo.js';
|
|
1469
1455
|
|
|
1470
1456
|
export namespace returnsTodo {
|
|
1471
1457
|
export interface Signature {
|
|
1472
|
-
(query: returnsTodo.Parameters): Promise<
|
|
1458
|
+
(query: returnsTodo.Parameters): Promise<returnsTodo.ReturnType>;
|
|
1473
1459
|
}
|
|
1474
1460
|
|
|
1475
1461
|
export interface Parameters {
|
|
@@ -1478,6 +1464,8 @@ describe("generator", () => {
|
|
|
1478
1464
|
*/
|
|
1479
1465
|
readonly someTodo: QueryParam.ObjectType<Todo>;
|
|
1480
1466
|
}
|
|
1467
|
+
|
|
1468
|
+
export type ReturnType = QueryResult.ObjectType<Todo>;
|
|
1481
1469
|
}
|
|
1482
1470
|
|
|
1483
1471
|
export interface returnsTodo extends QueryDefinition<returnsTodo.Signature>, VersionBound<$ExpectedClientVersion> {
|
|
@@ -1568,17 +1556,16 @@ describe("generator", () => {
|
|
|
1568
1556
|
});
|
|
1569
1557
|
describe("query depends on foreign object", () => {
|
|
1570
1558
|
it("generates the correct code", async () => {
|
|
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`);
|
|
1559
|
+
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"]]), true)).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1572
1560
|
expect(helper.getFiles()["/foo/ontology/queries/getTask.ts"]).toMatchInlineSnapshot(`
|
|
1573
|
-
"import type { QueryDefinition, VersionBound } from '@osdk/api';
|
|
1574
|
-
import type { QueryParam, QueryResult } from '@osdk/api';
|
|
1561
|
+
"import type { QueryDefinition, QueryParam, QueryResult, VersionBound } from '@osdk/api';
|
|
1575
1562
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
|
|
1576
1563
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1577
1564
|
import type { Task as $Imported$com$example$dep$Task } from '@com.example.dep/osdk';
|
|
1578
1565
|
|
|
1579
1566
|
export namespace getTask {
|
|
1580
1567
|
export interface Signature {
|
|
1581
|
-
(query: getTask.Parameters): Promise<
|
|
1568
|
+
(query: getTask.Parameters): Promise<getTask.ReturnType>;
|
|
1582
1569
|
}
|
|
1583
1570
|
|
|
1584
1571
|
export interface Parameters {
|
|
@@ -1587,6 +1574,8 @@ describe("generator", () => {
|
|
|
1587
1574
|
*/
|
|
1588
1575
|
readonly a: QueryParam.ObjectType<$Imported$com$example$dep$Task>;
|
|
1589
1576
|
}
|
|
1577
|
+
|
|
1578
|
+
export type ReturnType = QueryResult.ObjectType<$Imported$com$example$dep$Task>;
|
|
1590
1579
|
}
|
|
1591
1580
|
|
|
1592
1581
|
export interface getTask extends QueryDefinition<getTask.Signature>, VersionBound<$ExpectedClientVersion> {
|
|
@@ -1632,7 +1621,7 @@ describe("generator", () => {
|
|
|
1632
1621
|
});
|
|
1633
1622
|
describe("object uses on foreign spt", () => {
|
|
1634
1623
|
it("stuff", async () => {
|
|
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`);
|
|
1624
|
+
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"]]), true)).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1636
1625
|
expect(helper.getFiles()["/foo/ontology/objects/UsesForeignSpt.ts"]).toMatchInlineSnapshot(`
|
|
1637
1626
|
"import type { PropertyDef as $PropertyDef } from '@osdk/api';
|
|
1638
1627
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
@@ -1656,24 +1645,21 @@ describe("generator", () => {
|
|
|
1656
1645
|
export type Links = {};
|
|
1657
1646
|
|
|
1658
1647
|
export interface Props {
|
|
1659
|
-
readonly body: $PropType['string'] | undefined;
|
|
1660
|
-
readonly id: $PropType['integer'] | undefined;
|
|
1661
|
-
}
|
|
1662
|
-
export interface StrictProps {
|
|
1663
1648
|
readonly body: $PropType['string'] | undefined;
|
|
1664
1649
|
readonly id: $PropType['integer'];
|
|
1665
1650
|
}
|
|
1651
|
+
export type StrictProps = Props;
|
|
1666
1652
|
|
|
1667
1653
|
export interface ObjectSet extends $ObjectSet<UsesForeignSpt, UsesForeignSpt.ObjectSet> {}
|
|
1668
1654
|
|
|
1669
1655
|
export type OsdkInstance<
|
|
1670
|
-
OPTIONS extends never | '$
|
|
1656
|
+
OPTIONS extends never | '$rid' = never,
|
|
1671
1657
|
K extends keyof UsesForeignSpt.Props = keyof UsesForeignSpt.Props,
|
|
1672
1658
|
> = $Osdk.Instance<UsesForeignSpt, OPTIONS, K>;
|
|
1673
1659
|
|
|
1674
1660
|
/** @deprecated use OsdkInstance */
|
|
1675
1661
|
export type OsdkObject<
|
|
1676
|
-
OPTIONS extends never | '$
|
|
1662
|
+
OPTIONS extends never | '$rid' = never,
|
|
1677
1663
|
K extends keyof UsesForeignSpt.Props = keyof UsesForeignSpt.Props,
|
|
1678
1664
|
> = OsdkInstance<OPTIONS, K>;
|
|
1679
1665
|
}
|
|
@@ -1729,7 +1715,7 @@ describe("generator", () => {
|
|
|
1729
1715
|
});
|
|
1730
1716
|
describe("action depends on foreign object", () => {
|
|
1731
1717
|
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`);
|
|
1718
|
+
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"]]), true)).resolves.toMatchInlineSnapshot(`undefined`);
|
|
1733
1719
|
expect(helper.getFiles()["/foo/ontology/actions/setTaskBody.ts"]).toMatchInlineSnapshot(`
|
|
1734
1720
|
"import type {
|
|
1735
1721
|
ActionDefinition,
|
|
@@ -1834,7 +1820,7 @@ describe("generator", () => {
|
|
|
1834
1820
|
",
|
|
1835
1821
|
"/foo/ontology/interfaces.ts": "export { SomeInterface } from './interfaces/SomeInterface.js';
|
|
1836
1822
|
",
|
|
1837
|
-
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/
|
|
1823
|
+
"/foo/ontology/interfaces/SomeInterface.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
|
|
1838
1824
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1839
1825
|
|
|
1840
1826
|
import type {
|
|
@@ -1842,7 +1828,7 @@ describe("generator", () => {
|
|
|
1842
1828
|
ObjectSet as $ObjectSet,
|
|
1843
1829
|
Osdk as $Osdk,
|
|
1844
1830
|
PropertyValueWireToClient as $PropType,
|
|
1845
|
-
} from '@osdk/
|
|
1831
|
+
} from '@osdk/client';
|
|
1846
1832
|
|
|
1847
1833
|
export type OsdkObjectLinks$SomeInterface = {};
|
|
1848
1834
|
|
|
@@ -1852,20 +1838,18 @@ describe("generator", () => {
|
|
|
1852
1838
|
export interface Props {
|
|
1853
1839
|
readonly spt: $PropType['string'] | undefined;
|
|
1854
1840
|
}
|
|
1855
|
-
export
|
|
1856
|
-
readonly spt: $PropType['string'] | undefined;
|
|
1857
|
-
}
|
|
1841
|
+
export type StrictProps = Props;
|
|
1858
1842
|
|
|
1859
1843
|
export interface ObjectSet extends $ObjectSet<SomeInterface, SomeInterface.ObjectSet> {}
|
|
1860
1844
|
|
|
1861
1845
|
export type OsdkInstance<
|
|
1862
|
-
OPTIONS extends never | '$
|
|
1846
|
+
OPTIONS extends never | '$rid' = never,
|
|
1863
1847
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1864
1848
|
> = $Osdk.Instance<SomeInterface, OPTIONS, K>;
|
|
1865
1849
|
|
|
1866
1850
|
/** @deprecated use OsdkInstance */
|
|
1867
1851
|
export type OsdkObject<
|
|
1868
|
-
OPTIONS extends never | '$
|
|
1852
|
+
OPTIONS extends never | '$rid' = never,
|
|
1869
1853
|
K extends keyof SomeInterface.Props = keyof SomeInterface.Props,
|
|
1870
1854
|
> = OsdkInstance<OPTIONS, K>;
|
|
1871
1855
|
}
|
|
@@ -1902,21 +1886,21 @@ describe("generator", () => {
|
|
|
1902
1886
|
",
|
|
1903
1887
|
"/foo/ontology/objects.ts": "export { Task } from './objects/Task.js';
|
|
1904
1888
|
",
|
|
1905
|
-
"/foo/ontology/objects/Task.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/
|
|
1889
|
+
"/foo/ontology/objects/Task.ts": "import type { PropertyDef as $PropertyDef } from '@osdk/client';
|
|
1906
1890
|
import { $osdkMetadata } from '../../OntologyMetadata.js';
|
|
1907
1891
|
import type { $ExpectedClientVersion } from '../../OntologyMetadata.js';
|
|
1908
1892
|
import type {
|
|
1909
1893
|
PropertyKeys as $PropertyKeys,
|
|
1910
1894
|
ObjectTypeDefinition as $ObjectTypeDefinition,
|
|
1911
1895
|
ObjectMetadata as $ObjectMetadata,
|
|
1912
|
-
} from '@osdk/
|
|
1896
|
+
} from '@osdk/client';
|
|
1913
1897
|
import type {
|
|
1914
1898
|
ObjectSet as $ObjectSet,
|
|
1915
1899
|
Osdk as $Osdk,
|
|
1916
1900
|
OsdkObject as $OsdkObject,
|
|
1917
1901
|
PropertyValueWireToClient as $PropType,
|
|
1918
1902
|
SingleLinkAccessor as $SingleLinkAccessor,
|
|
1919
|
-
} from '@osdk/
|
|
1903
|
+
} from '@osdk/client';
|
|
1920
1904
|
|
|
1921
1905
|
export namespace Task {
|
|
1922
1906
|
export type PropertyKeys = 'taskId' | 'body';
|
|
@@ -1924,24 +1908,21 @@ describe("generator", () => {
|
|
|
1924
1908
|
export type Links = {};
|
|
1925
1909
|
|
|
1926
1910
|
export interface Props {
|
|
1927
|
-
readonly body: $PropType['string'] | undefined;
|
|
1928
|
-
readonly taskId: $PropType['string'] | undefined;
|
|
1929
|
-
}
|
|
1930
|
-
export interface StrictProps {
|
|
1931
1911
|
readonly body: $PropType['string'] | undefined;
|
|
1932
1912
|
readonly taskId: $PropType['string'];
|
|
1933
1913
|
}
|
|
1914
|
+
export type StrictProps = Props;
|
|
1934
1915
|
|
|
1935
1916
|
export interface ObjectSet extends $ObjectSet<Task, Task.ObjectSet> {}
|
|
1936
1917
|
|
|
1937
1918
|
export type OsdkInstance<
|
|
1938
|
-
OPTIONS extends never | '$
|
|
1919
|
+
OPTIONS extends never | '$rid' = never,
|
|
1939
1920
|
K extends keyof Task.Props = keyof Task.Props,
|
|
1940
1921
|
> = $Osdk.Instance<Task, OPTIONS, K>;
|
|
1941
1922
|
|
|
1942
1923
|
/** @deprecated use OsdkInstance */
|
|
1943
1924
|
export type OsdkObject<
|
|
1944
|
-
OPTIONS extends never | '$
|
|
1925
|
+
OPTIONS extends never | '$rid' = never,
|
|
1945
1926
|
K extends keyof Task.Props = keyof Task.Props,
|
|
1946
1927
|
> = OsdkInstance<OPTIONS, K>;
|
|
1947
1928
|
}
|